Repository navigation
feat(cli): Port the v3-to-v4 codemod from the archived getsentry/cli as cli3to4 - #1968
Open
sentry-junior[bot] wants to merge 11 commits into
Open
sentry-junior[bot] wants to merge 11 commits into
sentry-junior[bot] wants to merge 11 commits into
Conversation
getsentry/cli is archived, so its tag-triggered codemod publish workflow can no longer run and the migration guide pointed users at an archived repo. Move the codemod into packages/cli-codemod-v3-to-v4 so test.yml runs its jssg fixtures and type check, and publish it from this repo with Codemod's OIDC publish action. The package is now @getsentry/cli-v3-to-v4: Codemod verifies a scope against a public repository whose GitHub owner matches it, and this repository's owner is getsentry. Refs #1481 Co-Authored-By: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
1 of 19 tasks
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
- Stop flagging `headers` as dropped: v4 `SentryOptions` accepts it. Point `customHeader` users at `headers` instead. - Clear the whole argument list for nullish constructor args, so trailing commas (`new SentryCli(null,)`) no longer produce `SentryCli(,)`. - Run the workflow over `.tsx` files, with a separate `tsx`-grammar step for JSX/TSX so the typescript step keeps `<T>x` assertions parsing.
![sentry-warden[bot]](https://avatars.githubusercontent.com/in/2755838?s=60&v=4){kind=small}
…ented set-commits options
- Rewrite a bare `require("@sentry/cli")` to `require("sentry").default`.
v3 exported the class as `module.exports`; v4's CJS module object only
exposes the factory as `.default`/`createSentrySDK`.
- Keep the user's `setCommits` options object text verbatim and prepend
`orgVersion`, so a trailing `// comment` can't swallow the closing brace.
Codemod checks `.codemod/verification` on the default branch to confirm getsentry owns the `@getsentry` scope before the first publish. Co-Authored-By: BYK <126780+BYK@users.noreply.github.com>
BYK
requested changes
Nov 4, 2026
BYK
left a comment
BYK
left a comment
Member
There was a problem hiding this comment.
Let's rename this to cli3to4 or something short like that? Also please verify the Codemod still works and is accurate after all the changes we have done to the repo recently.
…atch v3's real API
Rename `@getsentry/cli-v3-to-v4` to `@getsentry/cli3to4` (package dir
`packages/cli3to4`).
Publish from pushes to main that change the `version` in codemod.yaml,
instead of from tags. `scripts/codemod-version-changed.mjs` compares the
version with the push's previous commit so other codemod.yaml edits don't
try to republish an existing version. Manual runs still publish.
Checked the transform against @sentry/cli 3.8.2's typings and the current v4
SDK, and fixed what had drifted:
- v3 exports the class as the named `SentryCli` (v2 used `module.exports`),
so `import { SentryCli }`, `const { SentryCli } = require(...)`,
`require(...).SentryCli` and `X.SentryCli` were left untouched before.
They now map to v4's named `createSentrySDK` export. `SentryCliOptions`
maps to `SentryOptions`; other v3 type exports get a TODO.
- v4's typed `release.deploy` now takes `environment`/`name`, so `newDeploy`
maps to it (renaming `env`) instead of falling back to `run(...)`.
- Map `listDeploys` → `release.deploys` and `sourceMaps.inject` →
`sourcemap.inject`; flag `releases.new` `projects` and the static
`getVersion()`/`getPath()` helpers.
- Fix the v3 example in the migration guide to use the named export.
sentry-junior
Bot
force-pushed
the
feat/cli-codemod-port
branch
from
November 4, 2026 23:23
1e0c02d to
87afd56
Compare
sentry-junior
Bot
changed the title
A file with only `import type { SentryCliOptions }` recorded no class
binding, so the codemod dropped its specifier and type rewrites and left
it on @sentry/cli. Commit those import edits when there is no binding.
…to packages/codemod-cli3to4
- releases.new(v, { projects }) now becomes release.create({ orgVersion, project })
with the array joined into v4's comma-separated string (a literal for
string-array literals, a runtime join otherwise). Only options with
extra keys still get a TODO.
- The v4 sentry library gains getVersion() and getPath(), also exposed as
static members of createSentrySDK, so v3's SentryCli.getVersion() and
SentryCli.getPath() keep working after the codemod. getPath() keeps a
TODO: it is a Node.js script now, not a native binary.
- Rename the directory to packages/codemod-cli3to4; the registry name
stays @getsentry/cli3to4.
Co-Authored-By: BYK <126780+BYK@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 21a6295. Configure here.
A conditional or other low-precedence projects value got `.join(",")`
appended to its last operand only. Wrap anything that isn't a plain
member/call/array expression in parentheses first.
…ine getPath
`require("@sentry/cli")` assigned later (`X = require(…)`), behind a
ternary or parens, or constructed inline (`new (require(…))()`) recorded
no binding, so constructor and method migration was skipped. Follow the
value through parens and ternary branches to its declarator or
assignment, treat an inline require as a constructor, and drop the
no-binding early return so these passes always run.
Also flag `require("@sentry/cli").getPath()` with the spawn TODO.
…m main `new SentryCli().releases.finalize(v)` dropped `new` but kept the v3 `releases` call, since only variables counted as instances. Treat an inline `new` expression as an instance too, and rewrite only the part of the call after its receiver so the constructor edits still apply. Manual runs of the publish workflow could publish any selected branch; gate the publish job on `refs/heads/main`.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
getsentry/cli is archived, which causes two problems:
This PR moves the codemod from
codemods/sentry-v3-to-v4(at getsentry/cli3567c3c) intopackages/codemod-cli3to4. Since it's now a workspace package,test.ymlruns its jssg fixtures and its type check through the usual per-package matrix. The fixture directories are excluded from oxlint and oxfmt, because they're intentional input/expected pairs. The migration guide now points at this repo.The package is renamed to
@getsentry/cli3to4. To publish under a scope, Codemod has to verify it against a public repository whose GitHub owner matches the scope (docs). This repo's owner isgetsentry, so@getsentryis the scope it can verify. Thesentryaccount on GitHub is a user with no public repos, so@sentrycan't be verified this way.Publishing runs on pushes to
mainthat change theversioninpackages/codemod-cli3to4/codemod.yaml. The workflow is path-filtered to that file, andscripts/codemod-version-changed.mjscompares the version with the push's previous commit. That way, other edits to codemod.yaml don't try to republish an existing version. It uses Codemod'scodemod/publish-action, pinned to a SHA, which fetches the GitHub Actions OIDC token. The old workflow ran a barecodemod publish, and the CLI only readsCODEMOD_AUTH_TOKEN, so it would not have authenticated. Manual runs from the Actions tab still publish.Checked against the real v3 and v4 APIs. I compared the transform with the
@sentry/cli3.8.2 typings and the current v4 SDK, and fixed what had drifted:SentryCli. v2 usedmodule.exports, and the old transform only handled that shape, so it left v3'simport { SentryCli }andconst { SentryCli } = require(...)untouched. These now map to v4's namedcreateSentrySDKexport, and so dorequire(...).SentryCliandX.SentryCli.release.deploynow takesenvironmentandname, sonewDeploymaps to it (renamingenv) instead of falling back torun(...).listDeploys→release.deploysandsourceMaps.inject→sourcemap.inject.releases.new(v, { projects })becomesrelease.create({ orgVersion: v, project }), with the array joined into v4's comma-separated string. A string-array literal becomes a string literal; anything else is joined at runtime. A TODO is left only when the options object has keys other thanprojects.sentrynow exportsgetVersion()andgetPath(), also available as static members ofcreateSentrySDK. Because the codemod bindsSentryClitocreateSentrySDK, v3'sSentryCli.getVersion()andSentryCli.getPath()keep working unchanged.getPath()returnsdist/bin.cjs, which is a Node.js script rather than v3's native binary, sogetPath()calls still get a TODO to spawn it withprocess.execPath. The library-usage and migration docs cover both, and the published type declarations include them..jsx/.tsx, using thetsxgrammar for those files.End-to-end check: a small v3 TypeScript project type-checks against
@sentry/cli3.8.2. After running the codemod workflow on it, it type-checks against the locally bundled v4sentrypackage. A CJS smoke run of the output loads the factory and runsrun("--version").Verification file: this PR adds
.codemod/verificationwith the code from the Codemod UI. The publish workflow runs on merge, before Verify now has been pressed, so that first run will fail. After merge, press Verify now on app.codemod.com forgetsentry/toolkit, then re-run the workflow (or run it manually) to publish0.1.0.Refs #1481, #1965
via @BYK.
--
View Session [Sentry]