Skip to content

Commit

Permalink
Merge pull request kubernetes#2208 from saschagrunert/schedule-builder
Browse files Browse the repository at this point in the history
Update schedule-builder docs
  • Loading branch information
k8s-ci-robot committed Aug 16, 2021
2 parents bbb7a06 + aa62e26 commit 7539975
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions cmd/schedule-builder/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Schedule Builder

This simple tool has the objective to parse the yaml file located in [SIG-Release](https://github.com/kubernetes/sig-release/blob/master/releases/), which shows the scheduled and past patch releases of the current Kubernetes Release cycle in machine readable format.
This simple tool has the objective to parse the yaml file located in
[k/website](https://github.com/kubernetes/website/blob/main/data/releases/schedule.yaml),
which shows the scheduled and past patch releases of the current Kubernetes
Release cycle in machine readable format.

## Install

Expand All @@ -16,17 +19,17 @@ Also if you have the `kubernetes/release` cloned you can run the `make release-t

## Usage

To run this tool you can just do, assuming you have cloned both `SIG-Release` and `Release` repositories, like
To run this tool you can just do, assuming you have cloned both `website` and `release` repositories, like

```
.
+-- kubernetes
| +-- sig-release
+-- k8s.io
| +-- release
| +-- website
```

```bash
$ schedule-builder --config-path ../sig-release/releases/schedule.yaml
$ schedule-builder --config-path ../website/data/releases/schedule.yaml
```

The output will be something similar to this
Expand Down Expand Up @@ -87,5 +90,5 @@ End of Life for **1.16** is **TBD**
Also can save the schedule in a file, to do that, you can set the `--output-file` flag together with the filename.

```
$ schedule-builder --config-path ../sig-release/releases/schedule.yaml --output-file my-schedule.md
$ schedule-builder --config-path ../website/data/releases/schedule.yaml --output-file my-schedule.md
```

0 comments on commit 7539975

Please sign in to comment.