Skip to content

Commit

Permalink
Update release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sbidoul committed Mar 10, 2024
1 parent 1799f0e commit 83ee2be
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -455,10 +455,11 @@ repository.

To release:

- Select the next version number of the form `X.Y.Z`.
- `towncrier --version vX.Y.Z`.
- Inspect and commit the updated `HISTORY.rst`.
- `git tag vX.Y.Z ; git push --tags`.
- Select the next version number of the form `X.Y(.Z)`.
- `towncrier --version X.Y(.Z)`.
- Inspect and commit the updated `CHANGELOG.md`.
- On GitHub, create a new release. Choose a tag of the form `vX.Y(.Z)`. Click `Generate
release notes` and copy over the content from `CHANGELOG.md`.

## Contributing

Expand Down

0 comments on commit 83ee2be

Please sign in to comment.