Skip to content

Commit

Permalink
docs: add note about committing release notes before generating a cha…
Browse files Browse the repository at this point in the history
…ngelog (#3181)

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
hairyhum and mergify[bot] authored Oct 14, 2024
1 parent 89a6575 commit d62f804
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ make reno-report VERSION=<pre-release-verstion>
```
And then committed to the pre-release branch.

**IMPORTANT** Reno scans commits to detect release notes. Only committed release notes will be added to the CHANGELOG files.

### 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 d62f804

Please sign in to comment.