Skip to content

chore: migrate changesets changelog generator#130

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

chore: migrate changesets changelog generator#130
Sheraff wants to merge 2 commits 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 deprecated compact package to the official GitHub changelog package.

Changes

  • Replace @svitejs/changesets-changelog-github-compact with @changesets/changelog-github in Changesets config.
  • Preserve the existing TanStack/hotkeys repo option and add disableThanks: true.
  • Update the root devDependency and pnpm lockfile to @changesets/changelog-github@^0.7.0.

Notes

Future changelog entries will use the official Changesets GitHub layout instead of the compact suffix layout. During lockfile refresh, pnpm's trust policy blocked ua-parser-js and express-rate-limit, so the install was rerun with --trust-policy-exclude for those two packages only.

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 official package references in config, package manifest, and lockfile.
  • node --input-type=module -e "const { default: changelog } = await import('@changesets/changelog-github'); const releaseLine = await changelog.getReleaseLine({ summary: 'Smoke migration check for #1', id: 'smoke' }, 'patch', { repo: 'TanStack/hotkeys', disableThanks: true }); console.log(releaseLine.includes('Smoke migration check') && releaseLine.includes('github.com/TanStack/hotkeys/issues/1') ? 'smoke-ok' : releaseLine);" returned smoke-ok.
  • pnpm changeset status --since=main completed and reported no packages to be bumped.
  • pnpm test:sherif completed with ✓ No issues found.

Summary by CodeRabbit

  • Chores
    • Updated development dependencies and changelog configuration to enhance build processes.

Review Change Stack

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

coderabbitai Bot commented May 26, 2026

📝 Walkthrough

Walkthrough

This PR replaces the compact GitHub changelog plugin with the standard GitHub changelog plugin. The configuration is updated in .changeset/config.json to specify the repository and disable automatic contributor thanks, while package.json devDependencies are synchronized to reflect the new package.

Changes

Changelog Tool Migration

Layer / File(s) Summary
Switch to GitHub changelog plugin
.changeset/config.json, package.json
Changelog plugin configuration migrated from @svitejs/changesets-changelog-github-compact to @changesets/changelog-github with repository setting and disableThanks option. Dependency entries updated to match the new package at version ^0.7.0.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • schiller-manuel

Poem

🐰 A changelog tool, refined and true,
From compact views to GitHub's hue,
With thanks disabled and repo set clear,
The perfect changelog now draws near! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description provides comprehensive context about the migration, changes made, and thorough verification steps, but does not follow the template structure with the required checklist sections. Fill in the PR description template sections: add a 🎯 Changes section header, complete the ✅ Checklist items, and specify the 🚀 Release Impact category.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: migrating the Changesets changelog generator from a deprecated package to an official one.
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

socket-security Bot commented May 26, 2026

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

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 26, 2026

Open in StackBlitz

@tanstack/angular-hotkeys

npm i https://pkg.pr.new/@tanstack/angular-hotkeys@130

@tanstack/hotkeys

npm i https://pkg.pr.new/@tanstack/hotkeys@130

@tanstack/hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/hotkeys-devtools@130

@tanstack/lit-hotkeys

npm i https://pkg.pr.new/@tanstack/lit-hotkeys@130

@tanstack/preact-hotkeys

npm i https://pkg.pr.new/@tanstack/preact-hotkeys@130

@tanstack/preact-hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/preact-hotkeys-devtools@130

@tanstack/react-hotkeys

npm i https://pkg.pr.new/@tanstack/react-hotkeys@130

@tanstack/react-hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/react-hotkeys-devtools@130

@tanstack/solid-hotkeys

npm i https://pkg.pr.new/@tanstack/solid-hotkeys@130

@tanstack/solid-hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/solid-hotkeys-devtools@130

@tanstack/svelte-hotkeys

npm i https://pkg.pr.new/@tanstack/svelte-hotkeys@130

@tanstack/vue-hotkeys

npm i https://pkg.pr.new/@tanstack/vue-hotkeys@130

@tanstack/vue-hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/vue-hotkeys-devtools@130

commit: 1f0231b

Copy link
Copy Markdown
Member

@crutchcorn crutchcorn left a comment

Choose a reason for hiding this comment

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

Thanks

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.

2 participants