Skip to content

Commit

Permalink
docs: Mention re-generating changelog when adding release notes to pr…
Browse files Browse the repository at this point in the history
…e-release PR (#3035)

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
hairyhum and mergify[bot] committed Aug 21, 2024
1 parent f54dca0 commit 9982f53
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,17 @@ This will result in creating a PR with a version bump, like https://github.com/k

This PR would update the older Kanister version reference in various files.

Pre-release PR should contain updates to CHANGELOG.md and CHANGELOG_CURRENT.md, which will be auto-generated
on workflow run.

**IMPORTANT** Reviewer of the pre-release PR should check if there are changelog items (release notes) for merged PRs and may add them in the pre-release PR if necessary.

After adding release notes, CHANGELOG.md and CHANGELOG_CURRENT.md should be re-generated using:
```
make reno-report VERSION=<pre-release-verstion>
```
And then committed to the pre-release branch.

### Release workflow

`release` workflow tags the repo using `release_tag` variable either from the merged pre-release PR or from workflow dispatch.
Expand Down

0 comments on commit 9982f53

Please sign in to comment.