Skip to content

chore: save aggregated changelog for edit before publish - #5558

Closed
mimarz wants to merge 1 commit into
mainfrom
chore-aggregate-release-edit
Closed

mimarz wants to merge 1 commit into
mainfrom
chore-aggregate-release-edit

Conversation

@mimarz

@mimarz mimarz commented Oct 29, 2026

Copy link
Copy Markdown
Collaborator

Summary

Makes the aggregated GitHub release notes editable in the release PR before they are published.

  • pnpm version-packages now writes the notes to RELEASE_NOTES.md, so the file is part of the changesets release PR and can be edited there.
  • create-aggregated-release.sh publishes RELEASE_NOTES.md when its first line matches the tag being released (<!-- release: vX.Y.Z -->). Otherwise it warns and builds the notes from the changelogs as before, so an old or missing file is never used for the wrong release.
  • aggregate-changelogs.js has a new --current mode that uses each package's version from its package.json, since the published-packages list doesn't exist until publishing.

Note: the changesets action rebuilds the release PR from main every time something is merged, which replaces any edits. Edit RELEASE_NOTES.md right before merging the release PR.

Testing

  • --current on 1.23.0 gives the same body as the published v1.23.0 release (plus the marker comment).
  • Ran the release script with a fake gh: an edited file for the matching tag is used, and a file for another version or a missing file falls back to the changelogs.

@changeset-bot

changeset-bot Bot commented Oct 29, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 7dbbebf

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@mimarz
mimarz marked this pull request as ready for review October 29, 2026 11:10
@mimarz

mimarz commented Oct 29, 2026

Copy link
Copy Markdown
Collaborator Author

See now that this might lead to drift between aggregated and individual changelogs. Tabling this for now.

@mimarz mimarz closed this Oct 29, 2026
@mimarz
mimarz deleted the chore-aggregate-release-edit branch October 29, 2026 12:07
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