Document towncrier changelog workflow in CONTRIBUTING.md and README.md#476
Merged
Document towncrier changelog workflow in CONTRIBUTING.md and README.md#476
Conversation
Both documents still told contributors to edit `changelog_entry.yaml` and run `make changelog`. Both have been deprecated for some time — the Versioning workflow runs towncrier on merge to compile fragments from `changelog.d/` into `CHANGELOG.md` and bump the version automatically. Contributors who follow the stale instructions hit the PR CI's "Check changelog fragment" step, which rejects branches that only have `changelog_entry.yaml`. Rewrites the "Changelog entries" / "Step 3: Changelogging" sections in both files with the fragment-type table and an `echo ... > changelog.d/...` example. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
MaxGhenis
force-pushed
the
docs-towncrier-contributing
branch
from
c6cb8b6 to
4e4d574
Compare
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.
Summary
Both
CONTRIBUTING.mdandREADME.mdstill told contributors to editchangelog_entry.yamland runmake changelog. Both have been deprecated for a while — the Versioning workflow runs towncrier on merge to compile fragments fromchangelog.d/intoCHANGELOG.mdand bump the version automatically. Contributors who follow the stale instructions hit the PR CI's "Check changelog fragment" step, which rejects branches that only havechangelog_entry.yaml.Rewrites the "Changelog entries" / "Step 3: Changelogging" sections with the fragment-type table and a concrete
echo ... > changelog.d/...example.Part of a sweep across PolicyEngine repos (policyengine-uk#1629, policyengine-us coming) to remove stale references so humans and AI agents alike land on the right path without a CI round-trip.
Test plan