Skip to content

✨ feat(release): require versioned changelog - #324

Merged
gaborbernat merged 11 commits into
tox-dev:mainfrom
gaborbernat:release-changelog-gate
Oct 18, 2026
Merged

gaborbernat merged 11 commits into
tox-dev:mainfrom
gaborbernat:release-changelog-gate

Conversation

@gaborbernat

@gaborbernat gaborbernat commented Oct 18, 2026 •

Copy link
Copy Markdown
Member

pyproject-api moved its release notes to GitHub Releases after 1.6.1, leaving no tracked changelog for contributors or the release workflow to check. This restores a versioned history through 1.12.0 and links it from the documentation.

Pull requests need a Towncrier fragment unless a maintainer applies skip news. One aggregate status covers the test matrix and fragment check. Release preparation builds the changelog without a write credential; a separate job checks the patch before the repository App commits and tags it. After PyPI publication, the tag workflow creates a GitHub Release with that version's changelog section, a PyPI link, and a comparison with the previous tag.

The App installation, RELEASE_APP_CLIENT_ID and RELEASE_APP_PRIVATE_KEY in release-auth, and the branch and tag rulesets need to be configured before merge.

@gaborbernat gaborbernat added the enhancement New feature or request label Oct 18, 2026
@gaborbernat gaborbernat added the skip news No user-facing changelog entry is needed label Oct 18, 2026
@gaborbernat
gaborbernat merged commit 0fbc6b5 into tox-dev:main Oct 18, 2026
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request skip news No user-facing changelog entry is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant