Repository navigation
ci(api): Add a reusable workflow that bumps @sentry/api in a consumer - #131317
Open
sentry-junior[bot] wants to merge 3 commits into
Open
sentry-junior[bot] wants to merge 3 commits into
sentry-junior[bot] wants to merge 3 commits into
Conversation
sentry-docs and toolkit each carry their own @sentry/api bump: a shell script that merges a PR in sentry-docs, and toolkit's rolling-PR script. bump-sentry-api-consumer.yml runs one script for both, ported from toolkit's, with a pin input (package.json dependency or pnpm catalog) and a mode input (merge, or one rolling PR that never merges). The consumers switch to it in their own PRs. Co-Authored-By: BYK <126780+BYK@users.noreply.github.com>
The merge mode now commits as the caller's own bot and opens its PR with --fill, as sentry-docs' script did. commit-author-name and commit-author-email default to github-actions[bot], which toolkit's rolling PR already uses. Co-Authored-By: BYK <126780+BYK@users.noreply.github.com>
This was referenced Nov 16, 2026
Open
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 0eec350. Configure here.
Callers already share a concurrency group, but the reusable job now holds its own per-repository group so overlapping dispatches can't race on the branch or the merge whatever the caller does.
This branch has not been 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.

sentry-docs and getsentry/toolkit each carry their own
@sentry/apibump: sentry-docs has a shell script that merges a PR, and toolkit has a Node script that keeps one rolling PR. This addsbump-sentry-api-consumer.yml, aworkflow_callworkflow both can call from a thinbump-sentry-api.yml, so the logic lives here next to the package. It follows up on #131244..github/workflows/scripts/bump-sentry-api.js, ported with its tests from toolkit'sscripts/bump-sentry-api.mjs. It runs in the caller's checkout.pininput:dependencypins an exactpackage.jsonversion withpnpm add --save-exact --lockfile-only, as sentry-docs does today.catalogupdates thepnpm-workspace.yamlcatalog and itsminimumReleaseAgeExcludeentry, as toolkit does today.modeinput:mergekeeps sentry-docs' current behavior. It commits "Bump @sentry/api to X" onbot/bump-sentry-api-to-X, opens the PR with--fill(or reuses one a failed run left open), and merges it with--squash --admin.rolling-prkeeps toolkit's current behavior. It keeps onebot/bump-sentry-apiPR, rebuilds it from the default branch and force-pushes it with a lease. If someone else pushed a commit to it, it leaves the PR alone with a warning (merge commits don't count). It never merges.app-client-idand theapp-private-keysecret name the GitHub App that pushes and opens the PR. A PR opened withgithub.tokendoesn't start the caller's CI. Inmergemode the app must also be allowed to--adminmerge.commit-author-nameandcommit-author-emailset the commit author. They default togithub-actions[bot], which toolkit uses today, and sentry-docs passes its own bot.@master. The workflow checks the script out frommastertoo, so the two always match.Merge order:
master.bump-sentry-api.yml.bump-api-schema-sha.ymlalias.via @BYK.
--
View Session [Sentry]