chore: clean Changesets output for root CHANGELOG#48
Merged
Conversation
- Name `payloadcms-vectorize` in the existing changeset so it gets a real narrative bullet, not just a silent version bump via the `fixed` group. - Drop the intro paragraph between `# Changelog` and the first version section so Changesets' insertion point lands cleanly between the H1 and the newest `##` entry. Together these produce a well-formed root CHANGELOG entry on the next release run instead of the empty `## 0.7.2` header we got from PR #47.
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
PR #47 (the automatic Version Packages PR) produced an ugly root
CHANGELOG.mddiff:## 0.7.2was inserted between the# ChangelogH1 and the intro paragraph, and had no bullet content because the changeset from #46 only named the adapter packages — the root was being silently pulled along by thefixedgroup with no narrative.This PR fixes both issues so the next Version Packages PR is clean.
Changes
.changeset/fix-adapter-type-declarations.md: addpayloadcms-vectorizeto the frontmatter. With thefixedgroup in.changeset/config.json, the root was already being bumped — but Changesets only writes a narrative bullet for packages explicitly named in the changeset. Naming the root fixes the empty-section problem.CHANGELOG.md: remove the intro paragraph between# Changelogand the first version section. The default@changesets/changelog-githubformatter inserts new content right after the H1, so anything between the H1 and the first##gets awkwardly sandwiched below the new release header.Expected output after merge
I ran
changeset:versionlocally to preview. The rootCHANGELOG.mdnow gets a proper entry:Follow-up
PR #47 was closed and the
changeset-release/mainbranch deleted so the release workflow regenerates a clean Version Packages PR when this one merges.Test plan
release.ymlfires, runschangeset:version, and opens a new "chore: version packages" PR.CHANGELOG.mdshould now have a full## 0.7.2section with PR link + @stevenlafl credit, not an empty header.release.ymlfires again,changeset publishauthenticates via Trusted Publishing OIDC, and all three packages publish at 0.7.2 on npm.