Skip to content

docs(develop): Use sentry-server for Sentry server CLI commands - #20297

Draft
sentry-junior[bot] wants to merge 1 commit into
masterfrom
rename-sentry-server-binary
Draft

sentry-junior[bot] wants to merge 1 commit into
masterfrom
rename-sentry-server-binary

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Rollout: sentry → sentry-server, getsentry → getsentry-server

Why: the new Sentry CLI ships a binary named sentry, which the server's console script shadows. Same rollout across all PRs below; keep this section in sync.

Phase 1: add new names and keep the old names as deprecated aliases (merge first)

Phase 2: move callers to the new names (after phase 1)

Phase 3: remove the aliases (only after prod manifests and self-hosted are confirmed off the old names)

  • getsentry/sentry: drop the sentry alias and clean up stale .venv/bin/sentry (TBD)
  • getsentry/getsentry: drop the getsentry alias (TBD)
  • Heads-up to sentry-kubernetes/charts (18+ templates use command: ["sentry"]) before the sentry alias is removed

DESCRIBE YOUR PR

The new Sentry CLI (getsentry/cli) is also installed as sentry, so getsentry/sentry is renaming its server console script to sentry-server (sentry stays as a deprecated alias for now).

This updates the developer and self-hosted docs that invoke the server binary directly (sentry devserver, sentry django ..., sentry run ..., sentry shell, sentry upgrade, sentry cleanup, etc.) to sentry-server <cmd>, and adds one short note on the dev environment page explaining the rename.

Intentionally left alone:

  • Self-hosted pages that use docker compose run --rm web <cmd> (the image entrypoint handles it).
  • The deprecated sentry devservices references, and release history in self-hosted/releases.mdx.
  • Anything under docs/ where sentry refers to the new Sentry CLI or legacy sentry-cli.

Merge order: after the getsentry/sentry PR adding sentry-server (getsentry/sentry#129100) merges; self-hosted pages should merge once the self-hosted release including it ships.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

  • 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

via @joshuarli.

--

View Junior Session [Sentry]

Co-Authored-By: David Cramer <david@sentry.io>
@vercel

vercel Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
develop-docs Ready Ready Preview Oct 28, 2026 9:29pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
sentry-docs Ignored Ignored Oct 28, 2026 9:29pm UTC

Request Review

This branch was successfully deployed

1 active deployment
Preview – develop-docs — 1b4b422a Deployed Oct 28, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants