[Release Checklist]: v0.11.5

[digikata]

Release Checklist

The following checklist covers all the steps for running release.

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
• [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)
  • [ ] Merge the PR
• [ ] Run the Release workflow in Github Actions (Retry at least once if failure)

If you are doing a prelease stop here before publishing crates. Only run publish crates for the finalized release.

• [ ] Verify that the crates publish to crates.io succeeds (Retry at least once if failure)
• [ ] Announce new release in Discord
• [ ] 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