Skip to content

Finish migration from yaml-changelog to towncrier#795

Merged
MaxGhenis merged 2 commits intomainfrom
docs-towncrier-contributing
Apr 17, 2026
Merged

Finish migration from yaml-changelog to towncrier#795
MaxGhenis merged 2 commits intomainfrom
docs-towncrier-contributing

Conversation

@MaxGhenis
Copy link
Copy Markdown
Contributor

@MaxGhenis MaxGhenis commented Apr 17, 2026

Summary

This repo was partway through the yaml-changelog → towncrier migration already:

  • pr.yaml runs towncrier check --compare-with origin/main
  • .github/bump_version.py infers the version bump from changelog.d/ fragment types
  • pyproject.toml carries [tool.towncrier] config with the five canonical fragment categories

What remained (stale, unused, or actively misleading):

  • yaml-changelog>=0.1.7 in pyproject.toml dev-deps — unused
  • .github/workflows/reusable_changelog_check.yaml — not wired into any workflow call-graph
  • changelog_entry.yaml at the repo root — zero bytes
  • changelog.yaml at the repo root — 601 lines, entire contents already compiled into CHANGELOG.md
  • .github/CONTRIBUTING.md — described the old yaml-changelog flow and told contributors to edit changelog_entry.yaml

This PR drops all of the above and rewrites .github/CONTRIBUTING.md to 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

  • 6 files changed, +63 / −649 (the large minus is mostly the retired changelog.yaml).
  • New changelog.d/.gitkeep (replacing the empty changelog_entry.yaml) and a single changelog.d/migrate-to-towncrier.changed.md fragment documenting this migration.

Test plan

  • pyproject.toml no longer references yaml-changelog
  • changelog_entry.yaml and changelog.yaml removed; history preserved in CHANGELOG.md and git log
  • reusable_changelog_check.yaml removed (was already unused)
  • changelog.d/.gitkeep exists so the towncrier directory survives
  • CI check-changelog (towncrier check) passes against this PR
  • Versioning workflow on merge runs towncrier build cleanly against the new fragment

@MaxGhenis MaxGhenis force-pushed the docs-towncrier-contributing branch from 0c7c462 to 330c7a7 Compare April 17, 2026 22:58
@MaxGhenis MaxGhenis changed the title Point CONTRIBUTING.md at the shared PolicyEngine guide Finish migration from yaml-changelog to towncrier Apr 17, 2026
….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>
@MaxGhenis MaxGhenis force-pushed the docs-towncrier-contributing branch from 330c7a7 to bc684f7 Compare April 17, 2026 23:06
@MaxGhenis MaxGhenis marked this pull request as ready for review April 17, 2026 23:07
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@MaxGhenis MaxGhenis merged commit 317a626 into main Apr 17, 2026
9 checks passed
@MaxGhenis MaxGhenis deleted the docs-towncrier-contributing branch April 17, 2026 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant