-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
chore(skills): Add bump-conventions skill #22271
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
4a331a4
09222c0
11ce45a
432fba1
3b57c72
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| --- | ||
| name: bump-conventions | ||
| description: Bump the @sentry/conventions dependency to a new version across every package in the monorepo. Use when upgrading, bumping, or aligning @sentry/conventions, or when a new @sentry/conventions release needs to be pulled into all workspaces. | ||
| argument-hint: '[version] # e.g. 0.16.0; defaults to latest on npm' | ||
| --- | ||
|
|
||
| # Bump `@sentry/conventions` | ||
|
|
||
| Bump `@sentry/conventions` across every `package.json` at once, keeping the two pin styles consistent, then refresh `yarn.lock`. | ||
|
|
||
| ## 1. Determine the target version | ||
|
|
||
| If the user gave a version, use it. Otherwise get the latest: | ||
|
|
||
| ```bash | ||
| npm view @sentry/conventions version | ||
| ``` | ||
|
|
||
| ## 2. Update every declared version | ||
|
|
||
| Find every `package.json` that declares `@sentry/conventions` (use the Grep tool so `node_modules` and build output are skipped automatically) and bump each to the new version. There are two pin styles, and **each must keep its style**: | ||
|
|
||
| - `packages/*` declare a caret range in `dependencies`, e.g. `"^0.15.1"` → `"^0.16.0"` | ||
| - `dev-packages/*` test suites declare an exact pin in `devDependencies`, e.g. `"0.15.1"` → `"0.16.0"` | ||
|
|
||
| Edit only the version string; leave the caret alone. If a file declares a version that matches neither the current caret nor the exact pin, list it and confirm with the user before touching it. Preserve each file's trailing newline. | ||
|
|
||
| ## 3. Refresh the lockfile and build | ||
|
|
||
| ```bash | ||
| yarn install | ||
| yarn dedupe-deps:fix | ||
| yarn build:dev | ||
| ``` | ||
|
|
||
| `yarn install` collapses the combined `yarn.lock` entry (`"@sentry/conventions@<OLD>", "@sentry/conventions@^<OLD>":`) onto the new version. Confirm no stale `<OLD>` resolution remains: | ||
|
|
||
| ```bash | ||
| grep -n '@sentry/conventions@' yarn.lock | ||
| ``` | ||
|
|
||
| ## 4. Check for breaking API changes | ||
|
|
||
| A `conventions` bump can rename or remove exported attribute constants. If `yarn build:dev` fails, inspect the type errors and update usages in `src/` **and** `test/`. Heaviest consumers: `packages/core`, `packages/opentelemetry`, `packages/aws-serverless`. | ||
|
|
||
| Use LSP `findReferences` on the changed export to catch every call site. Do not paper over a rename with a cast. | ||
|
|
||
| After fixing, re-run `yarn build:dev` and confirm it passes before verifying, so the next step runs against fresh build output. | ||
|
|
||
| ## 5. Final verification | ||
|
|
||
| ```bash | ||
| yarn circularDepCheck | ||
| yarn fix | ||
| yarn test | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Skips integration test verificationMedium Severity The skill’s API-fix and final verification steps rely on Reviewed by Cursor Bugbot for commit 11ce45a. Configure here. |
||
| ``` | ||
|
cursor[bot] marked this conversation as resolved.
|
||
|
|
||
| ## Commit | ||
|
|
||
| Use the `chore(deps):` prefix the repo uses for dependency bumps: | ||
|
|
||
| ``` | ||
| chore(deps): Bump `@sentry/conventions` to <NEW> | ||
| ``` | ||


There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: The
SKILL.mdguide is missing ayarn build:devstep after fixing code changes and before runningyarn test, causing tests to run against stale build artifacts.Severity: MEDIUM
Suggested Fix
Update the
SKILL.mdinstructions to add ayarn build:devcommand after Step 4 (fixing breaking changes) and before Step 5 (verification withyarn test). This will ensure that the code is re-compiled and tests are run against the latest changes.Prompt for AI Agent
Did we get this right? 👍 / 👎 to inform future reviews.