Skip to content

Commit

Permalink
doc(release): update release instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Khaled Emara <[email protected]>
  • Loading branch information
KhaledEmaraDev committed Oct 29, 2024
1 parent 10412d7 commit e03eec6
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,38 @@ To create a new release branch:

In the `main` branch:

1. Update the versions list in [params.toml](/config/_default/params.toml) to add the next release.
1. Add a new menu version corresponding to the new release branch in [params.toml](/config/_default/params.toml) that points to https://kyverno.io below these lines:

```toml
# version_menu = "Versions"
# Add your release versions here
[[menu.versions]]
version = "1.8.0"
url = "https://release-1-8-0.kyverno.io"
weight = 1
```

and change the older release version entry to point to its own versioned url, so for example if adding 1.13:

2. Update `version_menu` and `version` in [params.toml](/config/_default/params.toml) for the next release.
```toml
[[versions]] # New Line
version = "v1.13.0" # New Line
url = "https://kyverno.io" # New Line

3. Create a PR.
[[versions]]
version = "v1.11.0"
url = "https://release-1-12-0.kyverno.io" # Change this line
```

4. Clear the Netlify cache!
2. Clear the Netlify cache!

In the current release branch:

1. Update `params.toml` so that `version_menu` and `version` reflect the version of that release branch, NOT `main`. This is so when users navigate to the version of the docs represented in that version it shows the correct number.
1. Do the same as above.

2. Update `version` to the new release version. Following our example from above that would be `v1.13.0`.

3. Update `version_menu` to the same release version.

#### Submitting a PR to multiple release branches

Expand Down

0 comments on commit e03eec6

Please sign in to comment.