Skip to content

Document blue/green deploy runbook for deploy.ts switch-green and rollback #287

@mikewheeleer

Description

@mikewheeleer

Description

There is no operator runbook for the blue/green flow driven by src/deploy.ts and the npm run deploy:* scripts. Document the switch-green, rollback, and status procedures including health gating and the router on port 3000.

Requirements and context

  • Document deploy:switch-green, deploy:rollback, deploy:status, and the blue (3001)/green (3002)/router (3000) topology.
  • Include health-gate behavior, auto-rollback thresholds, and how to interpret deploy:status.
  • Cross-reference health.ts readiness and shutdown.ts drain timing.
  • Acceptance: runbook validated against actual command output; reviewed by an operator.

Suggested execution

  • Fork the repo and create a branch:
    • git checkout -b docs/blue-green-runbook
  • Implement changes:
    • docs/deploy.md
    • Tests: src/deploy.test.ts
    • Docs: docs/deploy.md
    • Include TSDoc/NatSpec-style doc comments
    • Validate security assumptions (input validation, auth, signature verification, secret redaction, idempotency)

Test and commit

  • Run tests: npm test (coverage: npm run test:ci)
  • Cover edge cases
  • Include test output and security notes in the PR

Example commit message

docs(deploy): add blue/green operator runbook

Guidelines

  • Minimum 95% line coverage on new/changed code
  • No secrets in repo; use .env + deployment secrets only
  • Clear documentation
  • Timeframe: 96 hours from assignment

Metadata

Metadata

Assignees

Type

No fields configured for Task.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions