Skip to content

Commit

Permalink
release documentation fixups
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Stoycos <[email protected]>
  • Loading branch information
astoycos committed Aug 16, 2023
1 parent 69519af commit 711ffc2
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@ For a **PATCH** release:
Github's [release][release] page.
- Run the `make build-install-yaml` command which will generate install files in the `release/` directory.
Attach these files to the Github release.
- Update the `README.md` and `site-src/guides/index.md` files to point links and examples to the new release.
- Update the website files to point links and examples to the new release (simply `grep` for previous version).
- Write a changelog for the new release in the [changelog readme](./CHANGELOG.md).
- Make the new-release from the [releases page](https://github.com/kubernetes-sigs/network-policy-api/releases) with the new changelog and attach the `install.yaml`.

For a **MAJOR** or **MINOR** release:

Expand All @@ -64,7 +66,9 @@ For a **MAJOR** or **MINOR** release:
Github's [release][release] page.
- Run the `make build-install-yaml` command which will generate install files in the `release/` directory.
Attach these files to the Github release.
- Update the `README.md` and `site-src/guides/index.md` files to point links and examples to the new release.
- Update the website files to point links and examples to the new release (simply `grep` for previous version).
- Write a changelog for the new release in the [changelog readme](./CHANGELOG.md).
- Make the new-release from the [releases page](https://github.com/kubernetes-sigs/network-policy-api/releases) with the new changelog and attach the `install.yaml`.

For an **RC** release:

Expand Down

0 comments on commit 711ffc2

Please sign in to comment.