ProxyWhirl Docs
Operations

CI/CD Pipeline

GitHub Actions workflows, quality gates, and deployment stages for ProxyWhirl.

Canonical workflow definitions live in .github/workflows/. Local parity gate:

just quality-gates

Primary Workflows

WorkflowTriggerPurpose
ci.ymlpush, PRLint, type check, tests, coverage, package build
security.ymlschedule, pushDependency and static analysis
validate-sources.ymlcron, manualStrict proxy source health
release.ymltagPyPI publish and GitHub release
cd.ymlmanualDeployment automation

Typical Pipeline Stages

  1. Lint and format check (just lint, just format-check)
  2. Type check (just type-check)
  3. Fast tests and coverage (just quality-gates)
  4. Docker image build (release/CD paths)
  5. Staging deploy and smoke tests (CD paths)
  6. Production deploy with approval (CD paths)

Local Commands

just lint
just format-check
just type-check
just test-fast
just coverage
uv build

Deployment Strategy

  • Staging: auto-deploy on main merges where CD is configured
  • Production: manual approval or tagged release
  • Rollback: use deploy/scripts/blue-green-deploy.sh rollback or redeploy prior artifact

See Release Process and Monitoring.

On this page