-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added a section on changelog management (#151)
- Loading branch information
1 parent
84e67ab
commit 3568bd9
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
## Cutting a new release | ||
|
||
### Creating the changelog | ||
|
||
To create a new release, you will need to have [unclog](https://github.com/informalsystems/unclog) installed. | ||
|
||
First, run: | ||
``` | ||
unclog release vX.Y.Z --editor nano | ||
``` | ||
This will move all the changelog entries from the `unreleased` folder into a new folder named after the release tag. It will also open an editor for you to write the release notes. | ||
For the release notes, include the date (as in `Date: October 15th, 2024`). You can | ||
optionally add a short summary of the release, but do not duplicate the changelog entries. | ||
|
||
Then, regenerate the `CHANGELOG` by running | ||
``` | ||
unclog build > CHANGELOG | ||
``` | ||
Finally, commit and push the changes to the repo. | ||
The up-to-date changelog should be present on the release branch for the release you have just cut, | ||
and also on main. |