Skip to content

chore: migrate changesets changelog generator#456

Open
Sheraff wants to merge 1 commit into
TanStack:mainfrom
Sheraff:chore/migrate-changesets-changelog-github
Open

chore: migrate changesets changelog generator#456
Sheraff wants to merge 1 commit into
TanStack:mainfrom
Sheraff:chore/migrate-changesets-changelog-github

Conversation

@Sheraff
Copy link
Copy Markdown
Contributor

@Sheraff Sheraff commented May 26, 2026

Summary

Migrate the Changesets changelog generator from the compact community package to the official GitHub changelog package.

Changes

  • Updated .changeset/config.json to use @changesets/changelog-github.
  • Preserved the existing repo option and added disableThanks: true.
  • Replaced the root dev dependency with @changesets/changelog-github at ^0.7.0.
  • Refreshed pnpm-lock.yaml with pnpm.

Notes

Future changelog entries will use the official Changesets GitHub layout instead of the compact suffix layout.

Verification

  • git grep -n "@svitejs/changesets-changelog-github-compact" returned no matches.
  • git grep -n "@changesets/changelog-github" -- .changeset/config.json package.json pnpm-lock.yaml confirmed config, root dev dependency, and lockfile entries.
  • node -e "import('@changesets/changelog-github').then((m)=>{ if (typeof m.default?.getReleaseLine !== 'function' || typeof m.default?.getDependencyReleaseLine !== 'function') throw new Error('missing changelog functions'); console.log('ok changelog exports') })" passed.
  • pnpm changeset status --since=main passed and reported no packages to be bumped.

Summary by CodeRabbit

  • Chores
    • Updated changelog generation tooling to streamline the release documentation workflow.

Review Change Stack

@Sheraff Sheraff requested a review from a team as a code owner May 26, 2026 17:19
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

📝 Walkthrough

Walkthrough

The PR updates the Changesets configuration to use the standard @changesets/changelog-github package instead of a compact custom variant. The corresponding devDependency is replaced, and configuration options are added to specify the repository and disable the thanks feature.

Changes

Changesets Changelog Generator Update

Layer / File(s) Summary
Update changelog generator package and configuration
package.json, .changeset/config.json
The devDependency replaces @svitejs/changesets-changelog-github-compact with @changesets/changelog-github@^0.7.0, and the Changesets configuration switches the changelog preset with new options for repository identification (repo: "TanStack/cli") and disabling thanks.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A changelog so neat, now keeping its thanks,
The compact is traded for standard ranks,
Configuration aligned with the new way,
Dependencies dance in the modern array! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore: migrate changesets changelog generator' clearly and concisely summarizes the main change: migrating from a compact changelog generator to the official Changesets GitHub changelog package.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@socket-security
Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Added@​changesets/​changelog-github@​0.7.01001006893100

View full report

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.changeset/config.json:
- Around line 4-5: The config entry for "`@changesets/changelog-github`" uses the
unsupported option "disableThanks"; update the .changeset/config.json entry to
remove "disableThanks" or replace it with the supported "exclude" object (keys:
"user", "pr", "commit") so suppression of "Thanks …" works with
`@changesets/changelog-github`@0.7.0—e.g., locate the
"`@changesets/changelog-github`" array item and either drop the disableThanks
property or convert it into an appropriate "exclude" object.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7fd2ab03-acec-4c09-bded-f83b11815866

📥 Commits

Reviewing files that changed from the base of the PR and between efb411e and 6774ffb.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • .changeset/config.json
  • package.json

Comment thread .changeset/config.json
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