From 9982f53578ae55f6d25f1b86ba53d52f37bf3aff Mon Sep 17 00:00:00 2001 From: Daniil Fedotov Date: Wed, 21 Aug 2024 17:04:16 -0400 Subject: [PATCH] docs: Mention re-generating changelog when adding release notes to pre-release PR (#3035) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- RELEASE.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/RELEASE.md b/RELEASE.md index f4b8dfec39..a19d6a5c08 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -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= +``` +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.