Skip to content

chore: migrate changesets changelog generator#1177

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

chore: migrate changesets changelog generator#1177
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 deprecated compact GitHub generator to the official Changesets GitHub generator.

Changes

  • Replace @svitejs/changesets-changelog-github-compact with @changesets/changelog-github.
  • Keep the existing TanStack/virtual repo option and add disableThanks: true.
  • Refresh pnpm-lock.yaml with pnpm.

Notes

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

Verification

  • pnpm install --ignore-scripts --no-frozen-lockfile
  • git grep -n "@svitejs/changesets-changelog-github-compact" -- .changeset package.json pnpm-lock.yaml || true
  • git grep -n "@changesets/changelog-github" -- .changeset package.json pnpm-lock.yaml
  • node --input-type=module -e 'import changelog from "@changesets/changelog-github"; const line = await changelog.getReleaseLine({ summary: "Fix link #123", commit: undefined }, "patch", { repo: "TanStack/virtual", disableThanks: true }); console.log(line.trim()); if (!line.includes("https://github.com/TanStack/virtual/issues/123")) process.exit(1);'
  • pnpm changeset status --since=main

Summary by CodeRabbit

  • Chores
    • Updated release management configuration and dependencies to improve changelog generation workflows.

Review Change Stack

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

coderabbitai Bot commented May 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a8117989-7762-47aa-bb04-354fa40a5d79

📥 Commits

Reviewing files that changed from the base of the PR and between 693d915 and 01e41be.

⛔ 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

📝 Walkthrough

Walkthrough

This PR migrates the Changesets changelog generation from a third-party compact GitHub plugin to the official @changesets/changelog-github package. The configuration and package dependencies are updated in tandem to complete the migration while preserving the repository reference and changelog settings.

Changes

Changelog Plugin Migration

Layer / File(s) Summary
Update changelog plugin and dependencies
.changeset/config.json, package.json
Changesets configuration replaces the compact GitHub changelog plugin with the official Changesets GitHub plugin, maintaining the TanStack/virtual repo setting and disabling thanks. The package dependency is updated to add @changesets/changelog-github and remove @svitejs/changesets-changelog-github-compact.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 From compact logs to official ways,
A changelog plugin meets brighter days,
GitHub and Changesets now unite,
With thanks disabled, configs shine so bright! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description provides a comprehensive summary with clear changes, notes, and detailed verification steps. However, it does not follow the repository's required template structure with 'Changes', 'Checklist', and 'Release Impact' sections. Restructure the description to match the template format with sections for 'Changes', 'Checklist', and 'Release Impact', and confirm whether a changeset was generated for this change.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore: migrate changesets changelog generator' accurately and concisely describes the main change: replacing the deprecated changelog generator with the official Changesets GitHub generator.
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

View your CI Pipeline Execution ↗ for commit 01e41be

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

☁️ Nx Cloud last updated this comment at 2026-05-26 17:49:55 UTC

@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

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 26, 2026

More templates

@tanstack/angular-virtual

npm i https://pkg.pr.new/@tanstack/angular-virtual@1177

@tanstack/lit-virtual

npm i https://pkg.pr.new/@tanstack/lit-virtual@1177

@tanstack/react-virtual

npm i https://pkg.pr.new/@tanstack/react-virtual@1177

@tanstack/solid-virtual

npm i https://pkg.pr.new/@tanstack/solid-virtual@1177

@tanstack/svelte-virtual

npm i https://pkg.pr.new/@tanstack/svelte-virtual@1177

@tanstack/virtual-core

npm i https://pkg.pr.new/@tanstack/virtual-core@1177

@tanstack/vue-virtual

npm i https://pkg.pr.new/@tanstack/vue-virtual@1177

commit: 01e41be

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