Skip to content

chore: migrate changesets changelog generator#10809

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

chore: migrate changesets changelog generator#10809
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 •
edited
Loading

Summary

  • Migrates Changesets changelog generation from @svitejs/changesets-changelog-github-compact to the official @changesets/changelog-github package.
  • Future changelog entries will use the official Changesets GitHub layout instead of the compact suffix layout.

Changes

  • Updates .changeset/config.json to use @changesets/changelog-github with repo: TanStack/query and disableThanks: true.
  • Replaces the root devDependency with @changesets/changelog-github ^0.7.0.
  • Refreshes pnpm-lock.yaml for the dependency swap.

Notes

  • pnpm install was first blocked by pnpm trust policy downgrades for ua-parser-js@1.0.41 and vite@6.4.1.
  • Lockfile refresh succeeded with the minimal package-specific exclusions: --trust-policy-exclude ua-parser-js@1.0.41 --trust-policy-exclude vite@6.4.1.

Verification

  • git grep -n "@svitejs/changesets-changelog-github-compact" -- ':!node_modules' || true
  • git grep -n "@changesets/changelog-github" -- .changeset/config.json package.json pnpm-lock.yaml
  • node --input-type=module -e "import changelog from '@changesets/changelog-github'; const line = await changelog.getReleaseLine({ summary: 'Fix issue Emulate debounce #123', commit: undefined }, 'patch', { repo: 'TanStack/query', disableThanks: true }); console.log(JSON.stringify(line));"
  • pnpm changeset status --since=main
  • pnpm run test:sherif

Summary by CodeRabbit

  • Chores
    • Updated changelog generation tooling configuration.

Review Change Stack

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

coderabbitai Bot commented May 26, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

The pull request replaces the compact GitHub changelog plugin with the official Changesets GitHub changelog plugin. The configuration in .changeset/config.json is updated to use @changesets/changelog-github with disableThanks: true, and the corresponding package is added to package.json devDependencies.

Changes

Changelog Plugin Update

Layer / File(s) Summary
Changelog plugin migration
.changeset/config.json, package.json		 The Changesets configuration replaces @svitejs/changesets-changelog-github-compact with @changesets/changelog-github (with disableThanks: true), and the new package is added to devDependencies at ^0.7.0.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • TkDodo

Poem

A changelog grows, now neat and bright,
No thanks required, just ships in flight,
From compact past to standard way,
The rabbit cheers this plugin's day! 🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning PR description provides comprehensive summary, motivation, and detailed verification steps, but lacks the required checklist confirmation items. Check off the two checklist items in the template: 'I have followed the Contributing guide' and 'I have tested this code locally with pnpm run test:pr', or clearly explain if they were completed.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: migrating the changelog generator package from a third-party compact version to the official Changesets 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.

@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented May 26, 2026 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 613ded7

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 4m 33s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 1s View ↗

☁️ Nx Cloud last updated this comment at 2026-05-26 18:48:50 UTC

@socket-security
Copy link
Copy Markdown

socket-security Bot commented May 26, 2026 •
edited
Loading

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 •
edited
Loading

More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@10809

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@10809

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@10809

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@10809

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@10809

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@10809

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@10809

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@10809

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@10809

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@10809

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@10809

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@10809

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@10809

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@10809

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@10809

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@10809

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@10809

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@10809

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@10809

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@10809

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@10809

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@10809

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@10809

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@10809

commit: 613ded7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TkDodo TkDodo TkDodo approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Sheraff @TkDodo