release-creator
Release preparation tools for Python projects. The notes command renders a tagged changelog section for a GitHub
Release. Other release tasks can use separate commands.
The documentation has a tutorial, how-to guides, a generated command reference, and an explanation of the changelog format.
Render GitHub Release notes
Run the current release from PyPI:
uvx --from 'release-creator' release-creator notes \
--changelog docs/changelog.md \
--tag 1.2.3 \
--repository tox-dev/example \
--previous 1.2.2 \
--artifact-url https://pypi.org/project/example/1.2.3/ > release-notes.md
For automation, replace release-creator after --from with a tested release-creator==VERSION. The command reads the
tagged section, maps Added to Features and Fixed to Bug fixes, changes linked author handles to GitHub mentions,
and leaves bullets unwrapped. It keeps stable category anchors, omits empty categories when they are absent from the
source, and adds artifact and comparison links. Use --artifact-label for an ecosystem other than PyPI; omit
--artifact-url when there is no external artifact.
The command also accepts a .rst changelog with the same category names. It links :issue: roles to issues and :pr:
or :pull: roles to pull requests:
uvx --from 'release-creator' release-creator notes \
--changelog docs/changelog.rst \
--tag 1.2.3 \
--repository tox-dev/example \
--previous 1.2.2 \
--artifact-url https://pypi.org/project/example/1.2.3/ > release-notes.md
The changelog is the source of truth. The command does not infer changes from commits or generate an author list.
Fragments carry no hand-written credits or PR references; validate-news rejects them. The GitHub Release body contains
only the tagged changelog section.
Named Towncrier fragments need no issue or PR number. Before Towncrier builds the changelog, run
release-creator fragments --repository owner/repo. The command reads the commits that introduced pending fragments,
asks GitHub which squash-merged pull request owns each commit, and adds its PR link and a credit computed from the merge
commit: the PR author first, then every other author and co-author. AI assistant identities are dropped, and bots are
credited only when they are the only author. The checkout needs complete fragment history, and gh needs read access to
the repository. Merge commits and rebase merges cannot identify a fragment's PR through its introducing commit; use
squash merges.
The tags command calculates a version from pending fragments, validates numeric tags, and selects the preceding tag
for GitHub comparisons:
git tag --list | uvx --from 'release-creator' release-creator tags --next auto
git tag --list | uvx --from 'release-creator' release-creator tags 1.2.3 --require-newer
git tag --list | uvx --from 'release-creator' release-creator tags 1.2.3 --previous
Development and releases
See contributing for the fragment format and release process. The package uses the same notes
command for its own GitHub Releases. Run tox -e 3.15,type,pkg_meta,docs and
prek run --all-files --config .pre-commit-config.yaml before a PR.
1 maintainer
Metadata
1 maintainer
Release files for release-creator 3.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| release_creator-3.1.0.tar.gz | 178.4 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| release_creator-3.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 230.2 kB
Release files / release_creator-3.1.0.tar.gz
| Download URL | release_creator-3.1.0.tar.gz |
|---|---|
| Size | 178.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7fba39aa52283c7edb4bf906656296a0696b4d23f6d6df85ef5d9a7abca7e1b2
|
|
BLAKE2b-256 checksum How to use checksums |
039873278ccb2393b27b702100a0eff5b387f2db6f06fc8aa0dea60bbfcbd402
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 25, 2026.
Transparency logRelease files / release_creator-3.1.0-py3-none-any.whl
| Download URL | release_creator-3.1.0-py3-none-any.whl |
|---|---|
| Size | 51.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e378a399af800452180ca1748dfb981b9f0115b634587226be927162b4b34f17
|
|
BLAKE2b-256 checksum How to use checksums |
35f220dca23b89aadcd846a7b36d763440a2e5cf2ef3b2adda350af16406aa52
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 25, 2026.
Transparency logSecurity for release-creator 3.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for release_creator-3.1.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 25, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
