Document towncrier changelog workflow; stop uv-lock bot writing changelog_entry.yaml#8061
Merged
Document towncrier changelog workflow; stop uv-lock bot writing changelog_entry.yaml#8061
Conversation
2 tasks
…ing changelog_entry.yaml Two stale references to the deprecated `changelog_entry.yaml` format were still telling people (and bots) to use it: 1. `CONTRIBUTING.md` — the "Work on issues" walkthrough instructed contributors to edit `changelog_entry.yaml` in step 3, then commit it. PRs following the docs silently fail the PR CI's "Check changelog fragment" step. 2. `.github/workflows/weekly-uv-lock.yaml` — the automated weekly uv-lock update bot wrote a YAML entry with `printf '%s\n' '- bump: patch' ...`. The bot's own PRs were failing the same check. Both now use the towncrier `changelog.d/<branch>.<type>.md` fragment format that `.github/workflows/pr.yaml`'s `Check changelog fragment` step actually validates. `CLAUDE.md` already says "DO NOT use changelog_entry.yaml (deprecated)" — this just brings the rest of the repo into alignment. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
MaxGhenis
force-pushed
the
docs-towncrier-contributing
branch
from
ba70537 to
8ae9fb0
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
Two stale references to the deprecated
changelog_entry.yamlformat were still telling humans (and bots) to use it:CONTRIBUTING.md— the "Work on issues" walkthrough instructed contributors to editchangelog_entry.yamlin step 3, then commit it. PRs following the docs silently fail the PR CI'sCheck changelog fragmentstep..github/workflows/weekly-uv-lock.yaml— the automated weekly uv-lock update bot wrote a YAML entry withprintf '%s\n' '- bump: patch' .... The bot's own PRs were failing the same check.Both now use the towncrier
changelog.d/<branch>.<type>.mdfragment format that.github/workflows/pr.yaml'sCheck changelog fragmentstep actually validates.CLAUDE.mdalready says "DO NOT usechangelog_entry.yaml(deprecated)" — this brings the rest of the repo into alignment.Part of a sweep across PolicyEngine repos (PolicyEngine/policyengine-uk#1629, PolicyEngine/policyengine-core#476) to remove stale references so contributors land on the right path without a CI round-trip.
Test plan
CONTRIBUTING.mdno longer referenceschangelog_entry.yamlormake changelogweekly-uv-lock.yamlwrites a proper towncrier fragment