Finish migration from yaml-changelog to towncrier#795
Merged
Conversation
0c7c462 to
330c7a7
Compare
….md at shared guide This repo was partway through the yaml-changelog → towncrier migration already: `pr.yaml` ran `towncrier check`, `.github/bump_version.py` inferred version bumps from `changelog.d/` fragment types, and `pyproject.toml` carried `[tool.towncrier]` config. The stale bits that remained: - Unused dep `yaml-changelog>=0.1.7` in `pyproject.toml` - Unused `.github/workflows/reusable_changelog_check.yaml` (not wired into any call-graph) - Zero-byte `changelog_entry.yaml` at the repo root - 601-line `changelog.yaml` whose entire contents are already compiled into `CHANGELOG.md` - A CONTRIBUTING.md that described the old yaml-changelog flow and told contributors to edit `changelog_entry.yaml` This PR drops all of the above and rewrites CONTRIBUTING.md to point at the new shared PolicyEngine guide (https://github.com/PolicyEngine/.github/blob/main/CONTRIBUTING.md, proposed in PolicyEngine/.github#3) plus a repo-specific section on commands, test placement, dataset-versioning rules, and anti-patterns. After this lands the repo matches the rest of the org (uk-data, core, uk, us, microdf, policyengine.py) on a single towncrier flow. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
330c7a7 to
bc684f7
Compare
Co-Authored-By: Claude Opus 4.7 (1M context) <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
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
This repo was partway through the yaml-changelog → towncrier migration already:
pr.yamlrunstowncrier check --compare-with origin/main.github/bump_version.pyinfers the version bump fromchangelog.d/fragment typespyproject.tomlcarries[tool.towncrier]config with the five canonical fragment categoriesWhat remained (stale, unused, or actively misleading):
yaml-changelog>=0.1.7inpyproject.tomldev-deps — unused.github/workflows/reusable_changelog_check.yaml— not wired into any workflow call-graphchangelog_entry.yamlat the repo root — zero byteschangelog.yamlat the repo root — 601 lines, entire contents already compiled intoCHANGELOG.md.github/CONTRIBUTING.md— described the old yaml-changelog flow and told contributors to editchangelog_entry.yamlThis PR drops all of the above and rewrites
.github/CONTRIBUTING.mdto point at the new shared PolicyEngine guide (PolicyEngine/.github#3) + a repo-specific section covering commands, test-placement rules, dataset-versioning, and anti-patterns.After this lands, the repo's changelog tooling matches the rest of the org (
policyengine-uk-data,policyengine-core,policyengine-uk,policyengine-us,microdf,policyengine.py) on a single towncrier flow.Diff shape
changelog.yaml).changelog.d/.gitkeep(replacing the emptychangelog_entry.yaml) and a singlechangelog.d/migrate-to-towncrier.changed.mdfragment documenting this migration.Test plan
pyproject.tomlno longer referencesyaml-changelogchangelog_entry.yamlandchangelog.yamlremoved; history preserved inCHANGELOG.mdand git logreusable_changelog_check.yamlremoved (was already unused)changelog.d/.gitkeepexists so the towncrier directory survivescheck-changelog(towncrier check) passes against this PRVersioningworkflow on merge runstowncrier buildcleanly against the new fragment