release-creator¶
release-creator links changelog fragments to squash pull requests, validates release tags, renders GitHub Release
notes, previews draft news in documentation, and refreshes pre-commit dependency pins. Install a published version with
uvx --from release-creator release-creator.
Run each command at the stage it serves:
Command |
When to run it |
Result |
|---|---|---|
After squash merge, before Towncrier builds the changelog |
Adds the pull request link to each named or numbered fragment |
|
Before preparing a release, then when making the comparison link |
Checks the version or prints its predecessor |
|
After the changelog and tag exist |
Prints the GitHub Release body from the tagged changelog |
|
Before each pull request documentation build |
Writes a copy of released history with pending fragments under Draft |
|
After a PyPI upload |
Verifies the published file set |
|
Before retrying a JetBrains Marketplace plugin upload |
Compares signed ZIP members with the published version |
|
During the weekly pre-commit update |
Updates exact hook dependency pins without rewriting other YAML |
Start with the tutorial for a complete release. Use the how-to guides for an existing project. The reference lists flags and input formats; the explanation covers the source of each part of a GitHub Release.
The changelog includes an Unreleased section in PR builds when that branch has fragments.
docs/changelog.md receives those entries when the release is prepared.