docs: add towncrier changelog management - #398
Merged
Merged
Conversation
Introduce towncrier-based changelog management to avoid CHANGELOG.md merge conflicts across the main/beta/httpx branch model. Contributors add one news fragment per user-facing change under changelog.d/; towncrier renders them into CHANGELOG.md at release time. - pyproject.toml: towncrier config + dev dependency - CHANGELOG.md: skeleton with towncrier marker - changelog.d/.gitignore: keep empty fragment dir tracked - create-release.yml: build + commit changelog before release - CONTRIBUTING.md, docs/releasing.md: fragment workflow docs Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
TKIPisalegacycipher
added a commit
that referenced
this pull request
Jun 10, 2026
Cherry-pick of the changelog infra from main (#398) onto beta, so the branch gets towncrier without entangling unrelated generated-API spec drift. beta accumulates its own changelog.d/ fragments, consumed by towncrier at the next beta release. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
TKIPisalegacycipher
added a commit
that referenced
this pull request
Jun 10, 2026
Cherry-pick of the changelog infra from main (#398) onto httpx. Kept httpx's own dev deps (respx, pytest-benchmark, hypothesis, pytest-json-report) alongside towncrier; regenerated uv.lock. The existing +httpx-migration fragment renders correctly in a draft build. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Introduce towncrier-based changelog management to eliminate
CHANGELOG.mdmerge conflicts across themain/beta/httpxbranch model.Contributors add one news fragment per user-facing change under
changelog.d/; towncrier renders them intoCHANGELOG.mdat release time. Different filenames mean zero conflicts on parallel branches.Changes
[tool.towncrier]+ 6 change types) and dev dependencyBuild changelogstep renders + commitsCHANGELOG.mdbefore the release is cut (needscontents: write).worktrees/Rollout (trunk-down)
This is the infra, targeting
mainas the single source of truth. After merge:main→beta→httpxso the infra propagatesThe httpx migration fragment already lives on
httpxand will be consumed once this infra reaches it.Verification
towncrier build --draftrenders correctly;uv.lockregenerated withtowncrier.🤖 Generated with Claude Code