Skip to content

chore: clean Changesets output for root CHANGELOG#48

Merged
techiejd merged 1 commit intomainfrom
fix/changelog-changeset-structure
Apr 21, 2026
Merged

chore: clean Changesets output for root CHANGELOG#48
techiejd merged 1 commit intomainfrom
fix/changelog-changeset-structure

Conversation

@techiejd
Copy link
Copy Markdown
Owner

Summary

PR #47 (the automatic Version Packages PR) produced an ugly root CHANGELOG.md diff: ## 0.7.2 was inserted between the # Changelog H1 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 the fixed group with no narrative.

This PR fixes both issues so the next Version Packages PR is clean.

Changes

  • .changeset/fix-adapter-type-declarations.md: add payloadcms-vectorize to the frontmatter. With the fixed group 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 # Changelog and the first version section. The default @changesets/changelog-github formatter 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:version locally to preview. The root CHANGELOG.md now gets a proper entry:

# Changelog

## 0.7.2

### Patch Changes

- [#46](https://github.com/techiejd/payloadcms-vectorize/pull/46) [\`664b2b6\`](...) Thanks [@stevenlafl](...)! - Fix missing TypeScript declarations in \`@payloadcms-vectorize/pg\` and \`@payloadcms-vectorize/cf\`. The build now runs \`tsc\` before SWC...

## 0.7.1 - 2026-03-20
...

Follow-up

PR #47 was closed and the changeset-release/main branch deleted so the release workflow regenerates a clean Version Packages PR when this one merges.

Test plan

  • Merge this PR.
  • Confirm release.yml fires, runs changeset:version, and opens a new "chore: version packages" PR.
  • Review that new PR — root CHANGELOG.md should now have a full ## 0.7.2 section with PR link + @stevenlafl credit, not an empty header.
  • Merge the Version Packages PR.
  • Confirm release.yml fires again, changeset publish authenticates via Trusted Publishing OIDC, and all three packages publish at 0.7.2 on npm.

- 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.
@techiejd techiejd merged commit e7504e0 into main Apr 21, 2026
7 checks passed
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