Skip to content

release-notes.md

Latest commit

 

History

History
32 lines (26 loc) · 1.41 KB

release-notes.md

File metadata and controls

32 lines (26 loc) · 1.41 KB

Release Notes (CHANGELOG.md)

CHANGELOG.md is prepend-only — each release adds a new section at the top. Previous release sections are never modified by the tooling.

The release workflow:

  1. Changesets are merged to main as .changeset/*.md files.
  2. The Changesets GitHub Action opens a "Version Packages" PR (#82 etc.) that runs changeset version, which:
    • Consumes all .changeset/*.md files
    • Prepends a new release section to CHANGELOG.md
    • Bumps package.json version
  3. scripts/changelog-audience-summary.mjs post-processes the new section only, adding the "Who should read this release" block.
  4. Merging the Version Packages PR tags the release.

Key implications:

  • Editing old release sections in CHANGELOG.md is safe — the tooling only touches the newest section.
  • Editing the Version Packages PR body only changes the preview — it does NOT change what gets written to CHANGELOG.md. The PR body is regenerated from scratch on every push to main that adds/changes changesets.
  • To fix attribution (e.g. adding a co-author Thanks credit), edit CHANGELOG.md directly on the changeset-release/main branch before merging the Version Packages PR. The Thanks line is generated by @changesets/changelog-github from the git commit author — it cannot be overridden via changeset file content.

See docs/PUBLISHING.md for the full release workflow.