Skip to content

docs(sdk): Update cutting-a-release playbook to use GitHub Actions only#16831

Draft
dingsdax wants to merge 1 commit intomasterfrom
dev-docs/playbooks/cutting-a-release-ci-only
Draft

docs(sdk): Update cutting-a-release playbook to use GitHub Actions only#16831
dingsdax wants to merge 1 commit intomasterfrom
dev-docs/playbooks/cutting-a-release-ci-only

Conversation

@dingsdax
Copy link
Contributor

@dingsdax dingsdax commented Mar 7, 2026

DESCRIBE YOUR PR

Updates the "Cutting a Release" playbook to reflect that all Sentry SDK releases are triggered exclusively through GitHub Actions — never via local craft prepare / craft publish CLI invocations.

Changes:

  • Replace craft prepare <version> bash block with GitHub Actions UI instructions (Actions tab → find workflow → Run workflow)
  • Document the version: auto input option supported by several SDKs
  • Add a step for polishing the release branch changelog while CI runs
  • Correct the publish approval flow: it's an issue in getsentry/publish labeled accepted, not a PR merge
  • Make the "you must not approve your own release" requirement explicit
  • Fix step 1 to say "default branch" instead of "release branch" for gating criteria check
  • Bump spec to v1.1.0

IS YOUR CHANGE URGENT?

  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

Replace CLI invocation of Craft (craft prepare / craft publish) with
the GitHub Actions workflow approach. All SDK repos trigger releases
exclusively through CI via workflow_dispatch — never from a local machine.

Also correct the publish flow description: the approval mechanism is an
issue in getsentry/publish labeled 'accepted', not a PR merge. Add a
step for polishing the release branch changelog, and make the two-person
approval requirement explicit.

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Mar 7, 2026

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

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Mar 7, 2026 8:42am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
sentry-docs Ignored Ignored Mar 7, 2026 8:42am

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant