Skip to content

chore(upgrade): Remove dead generate-changelog file#8686

Merged
dominic-clerk merged 2 commits into
mainfrom
dc-remove-dead-generate-changelog
May 28, 2026
Merged

chore(upgrade): Remove dead generate-changelog file#8686
dominic-clerk merged 2 commits into
mainfrom
dc-remove-dead-generate-changelog

Conversation

@dominic-clerk
Copy link
Copy Markdown
Contributor

Description

This appears not to be used at all and refers to a ../versions/v5 path that doesn't exist anymore.

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@vercel
Copy link
Copy Markdown

vercel Bot commented May 28, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment May 28, 2026 2:17pm

Request Review

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 28, 2026

🦋 Changeset detected

Latest commit: b96812d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@clerk/upgrade Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: fe913c3d-789a-4705-98a1-5b24f00b770d

📥 Commits

Reviewing files that changed from the base of the PR and between 615815b and b96812d.

📒 Files selected for processing (1)
  • .changeset/moody-rules-carry.md
✅ Files skipped from review due to trivial changes (1)
  • .changeset/moody-rules-carry.md

📝 Walkthrough

Walkthrough

This PR removes the unused generate-changelog.js utility from the upgrade package and adds a changeset metadata file. The changelog generator, which dynamically imported versioned SDK data and formatted Markdown output, is no longer needed. The changeset file records a patch-level bump for @clerk/upgrade and documents the removal of the unused script.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: removing an unused generate-changelog file, which is the core objective of this PR.
Description check ✅ Passed The description is directly related to the changeset, explaining why the file is being removed and confirming test/build passes.
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.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 28, 2026

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@8686

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@8686

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@8686

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@8686

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@8686

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@8686

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@8686

@clerk/express

npm i https://pkg.pr.new/@clerk/express@8686

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@8686

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8686

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@8686

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@8686

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@8686

@clerk/react

npm i https://pkg.pr.new/@clerk/react@8686

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@8686

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@8686

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@8686

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@8686

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8686

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@8686

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@8686

commit: b96812d

Copy link
Copy Markdown
Contributor

@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/warm-spies-clean.md:
- Around line 1-2: The changeset file .changeset/warm-spies-clean.md is empty
but must include a version bump for the public package `@clerk/upgrade` because
removing packages/upgrade/src/util/generate-changelog.js affects the published
dist; update the changeset to include a package entry (for example
`"`@clerk/upgrade`": patch`) and a short summary like "Remove unused
generate-changelog utility" so the package version is bumped when releasing.
🪄 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: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 507e8ba7-24da-4ac1-b7a4-d131157a4ea8

📥 Commits

Reviewing files that changed from the base of the PR and between 543abd7 and 615815b.

📒 Files selected for processing (1)
  • .changeset/warm-spies-clean.md

Comment thread .changeset/warm-spies-clean.md Outdated
Comment on lines +1 to +2
---
---
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 28, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Check if `@clerk/upgrade` is a published package and verify the removed file

# Check if the package is published (look for private field)
echo "=== Checking package.json for `@clerk/upgrade` ==="
cat packages/upgrade/package.json | jq '{name: .name, version: .version, private: .private}'

# Verify if generate-changelog.js existed and check for any imports
echo -e "\n=== Checking for references to generate-changelog ==="
rg -n "generate-changelog" --type=js --type=ts -g '!node_modules' -g '!.changeset' -C2

Repository: clerk/javascript

Length of output: 236


🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "=== Inspect changeset file ==="
ls -la .changeset/warm-spies-clean.md || true
cat -n .changeset/warm-spies-clean.md || true

echo "=== Inspect changesets config ==="
ls -la .changeset || true
ls -la .changeset/config.json .changeset/config.* 2>/dev/null || true
if [ -f .changeset/config.json ]; then
  cat .changeset/config.json
fi

echo "=== Check whether generate-changelog.js still exists ==="
fd -a "generate-changelog\.js" . || true
fd -a "generate-changelog" packages -t f || true

echo "=== Verify whether `@clerk/upgrade` is public and what scripts use changesets ==="
cat -n packages/upgrade/package.json | sed -n '1,120p'
rg -n "\"changeset\"|changeset|`@changesets`" package.json packages -S --glob '!**/node_modules/**' || true

Repository: clerk/javascript

Length of output: 4225


🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "=== Locate removed file (src/util/generate-changelog.js) ==="
fd -a "generate-changelog\.js" packages/upgrade -t f || true
ls -la packages/upgrade/src/util 2>/dev/null || true

echo "=== Search for references to generate-changelog across the package ==="
rg -n "generate-changelog" packages/upgrade -S --glob '!**/node_modules/**' || true

echo "=== Search for generate/changelog patterns (to catch renamed imports) ==="
rg -n "(generate.*changelog|changelog.*util|generateChangelog)" packages/upgrade/src -S --glob '!**/node_modules/**' || true

echo "=== Check if dist exists and whether it would have contained it ==="
ls -la packages/upgrade/dist 2>/dev/null || true
fd -a "generate-changelog" packages/upgrade/dist -t f 2>/dev/null || true

Repository: clerk/javascript

Length of output: 704


🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "=== Search for 'changeset --empty' usage/docs ==="
rg -n "changeset:empty|--empty|empty changeset" package.json .changeset -S || true

echo "=== Read .changeset/README.md (look for empty changesets guidance) ==="
sed -n '1,200p' .changeset/README.md || true
sed -n '200,500p' .changeset/README.md || true

echo "=== Inspect root changeset changelog/build scripts (if any) ==="
rg -n "changeset( publish| version| --empty)" package.json -S || true

Repository: clerk/javascript

Length of output: 1271


Add a version bump for @clerk/upgrade (don’t keep this changeset empty)

@clerk/upgrade is public (publishConfig.access: "public", files: ["dist"]) and its build runs Babel over the whole src tree with --copy-files, so removing packages/upgrade/src/util/generate-changelog.js changes what ends up in the published dist. Replace the empty changeset with a package version entry, e.g.:

---
"`@clerk/upgrade`": patch
---

Remove unused generate-changelog utility
🤖 Prompt for 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.

In @.changeset/warm-spies-clean.md around lines 1 - 2, The changeset file
.changeset/warm-spies-clean.md is empty but must include a version bump for the
public package `@clerk/upgrade` because removing
packages/upgrade/src/util/generate-changelog.js affects the published dist;
update the changeset to include a package entry (for example `"`@clerk/upgrade`":
patch`) and a short summary like "Remove unused generate-changelog utility" so
the package version is bumped when releasing.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Agree. This does change the published dist, so a changeset is needed

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

New changelog file generated in b96812d

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

Copy link
Copy Markdown
Member

@jacekradko jacekradko left a comment

Choose a reason for hiding this comment

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

Looks good, but we should add a changeset for correctness

@dominic-clerk dominic-clerk force-pushed the dc-remove-dead-generate-changelog branch from 615815b to 543abd7 Compare May 28, 2026 14:15
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

Actionable comments posted: 0

@dominic-clerk dominic-clerk merged commit 5c68f3f into main May 28, 2026
43 checks passed
@dominic-clerk dominic-clerk deleted the dc-remove-dead-generate-changelog branch May 28, 2026 14:19
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