Skip to content

[Docs] No staging deploy/rollback runbook - deploy-staging.yml has rollback logic, STAGING_ENABLED gating, and STAGING_SSH_* secrets documented nowhere #1253

Description

@grantfox-oss

Telegram (ask questions / claim the issue here first): https://t.me/+DOylgFv1jyJlNzM0

Why this matters

docs/runbooks/ contains only indexer-recovery.md, yet deploy-staging.yml implements a non-trivial pipeline: staging-previous backup/rollback, vars.STAGING_ENABLED == true gating, required secrets (STAGING_SSH_HOST/USER/KEY/PORT), server-side migrate:up, and backend/frontend health checks. There is no runbook telling an on-call engineer how to enable staging, which secrets/vars to set, or how to manually roll back to remitlend-*:staging-previous when the automated rollback also fails.

Acceptance criteria

  • A docs/runbooks/staging-deploy.md (linked from runbooks/README.md) documents required GitHub secrets/vars and the STAGING_ENABLED toggle
  • Includes manual rollback steps using the staging-previous tag and rollback compose file
  • Covers the health-check ports (backend 3001/health, frontend 3000) and where to read logs

Files to touch

  • docs/runbooks/README.md
  • .github/workflows/deploy-staging.yml
  • docker-compose.staging.yml

Out of scope

  • Documenting a production deploy pipeline that does not yet exist
  • Secret rotation policy

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdevopsIssues related to CI/CD and infrastructuredocsDocumentationdocumentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions