Skip to content

Commit cd2bd9b

Browse files
committed
Move "Update CHANGELOG" before "Create and push release tag" in RELEASE.md
The changelog should be updated and committed before tagging the release, not after.
1 parent a85f7a7 commit cd2bd9b

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

RELEASE.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@ Note: `main` (`6.x` and later) only
1212
Please see [this guide](https://github.com/rabbitmq/rabbitmq-dotnet-client/blob/main/APIDOCS.md).
1313

1414

15+
## Update CHANGELOG
16+
17+
Run `tools/generate-changelog.sh` with the previous tag and the new tag:
18+
19+
```
20+
tools/generate-changelog.sh v7.X.Y v7.X.(Y+1)
21+
```
22+
23+
This inserts a new section into `CHANGELOG.md` after the `# Changelog` header.
24+
The release date is set to `UNRELEASED-DATE` as a placeholder. Review the
25+
output with `git diff CHANGELOG.md` and edit as needed before committing.
26+
27+
1528
## Create and push release tag
1629

1730
Note: `alpha` releases are versioned by default via the MinVer package. The version is based off of the most recent tag.
@@ -53,16 +66,3 @@ dotnet nuget push -k NUGET_API_KEY -s https://api.nuget.org/v3/index.json ./pack
5366
* Close the appropriate milestone, and make a note of the link to the milestone with closed issues visible
5467
* Use the GitHub web UI or `gh release create` command to create the new release
5568
* GitHub actions will build and publish the release to NuGet
56-
57-
58-
## Update CHANGELOG
59-
60-
Run `tools/generate-changelog.sh` with the previous tag and the new tag:
61-
62-
```
63-
tools/generate-changelog.sh v7.X.Y v7.X.(Y+1)
64-
```
65-
66-
This inserts a new section into `CHANGELOG.md` after the `# Changelog` header.
67-
The release date is set to `UNRELEASED-DATE` as a placeholder. Review the
68-
output with `git diff CHANGELOG.md` and edit as needed before committing.

0 commit comments

Comments
 (0)