Release Checklist

The following checklist covers all the steps for running release.

First, a pre-release is published which is used to ensure all systems operate correctly in development environments. Once the pre-release is confirmed to be working, the final release is published.

For more detail, refer to RELEASE.md

[x] Create a new issue with this checklist template
[x] Review all the Getting Started and API docs. Verify if they are up to date or will need updates
[x] Inform team that release is about to begin
[x] Ensure no merges are in flight

Pre-Release

[x] Run the Release workflow in Github Actions, make sure the pre-release check is set. (Retry at least once if failure)
[x] Perform a pre-release test in a development environment

Stable Release

If all systems are operational and no bugs are found in the pre-release, the final release can be published.

[x] Create a PR for release
- [x] Update VERSION and CHANGELOG.md files (do not place a \n in the VERSION file, it breaks the CI)
- [x] Merge the PR
[x] Run the Release workflow in Github Actions without the pre-release check.
[x] Verify that the crates publish to crates.io succeeds (Retry at least once if failure)
[x] Announce new release in Discord
[x] To close this issue, create a PR for post release updates and use release_template.md
- Add form data template=release_template.md to the PR URL while creating in order to use template
- e.g. https://github.com/infinyon/fluvio/compare/master...username:your-branch?expand=1&template=release_template.md
- or gh pr create --template=release_template.md a closes issue #x in the body will automatically close this issue on merge.

Generating Release notes

To get a starting point for generating release notes the view-changelog script can be used. git cliff is used to generate a changelog update. The view-changelog script can be used to view the new entries or modifty the CHANGELOG.md file.

To view the changelog updates:

actions/view-changelog.sh

or to prepend the updates (some post editing is still usually required):

actions/view-changelog.sh modify

infinyon / fluvio