docs(ops): add staging deployment checklist and evidence template
This commit is contained in:
@@ -12,6 +12,7 @@ This section covers platform and implementation documentation for engineers and
|
||||
- [CRUD Examples](/product-engineering/crud-examples)
|
||||
- [Domain Glossary](/product-engineering/domain-glossary)
|
||||
- [Environment Runbook](/product-engineering/environment-runbook)
|
||||
- [Staging Deployment Checklist](/product-engineering/staging-deployment-checklist)
|
||||
- [Delivery Pipeline](/product-engineering/delivery-pipeline)
|
||||
- [Git Flow Governance](/product-engineering/git-flow-governance)
|
||||
- [Testing Strategy Baseline](/product-engineering/testing-strategy)
|
||||
|
||||
100
docs/product-engineering/staging-deployment-checklist.md
Normal file
100
docs/product-engineering/staging-deployment-checklist.md
Normal file
@@ -0,0 +1,100 @@
|
||||
# Staging Deployment Checklist
|
||||
|
||||
## Purpose
|
||||
|
||||
Operational checklist for the first real staging deployment using `.gitea/workflows/deploy.yml`.
|
||||
|
||||
Use this once end-to-end, save the record, then mark MVP0 staging deployment as complete in `TODO.md`.
|
||||
|
||||
## Preconditions
|
||||
|
||||
- Docker host for staging is reachable via SSH.
|
||||
- Gitea repo secrets are configured:
|
||||
- `CMS_STAGING_HOST`
|
||||
- `CMS_STAGING_USER`
|
||||
- `CMS_DEPLOY_KEY`
|
||||
- `CMS_REMOTE_DEPLOY_PATH`
|
||||
- `CMS_IMAGE_REGISTRY`
|
||||
- `CMS_IMAGE_NAMESPACE`
|
||||
- `CMS_IMAGE_REGISTRY_USER`
|
||||
- `CMS_IMAGE_REGISTRY_PASSWORD`
|
||||
- Release image tag exists in registry (e.g. `v0.1.0`).
|
||||
- Remote deploy path contains:
|
||||
- `docker-compose.staging.yml`
|
||||
- staging env file(s) needed by compose
|
||||
|
||||
## Step-by-Step Execution
|
||||
|
||||
1. Verify release images exist:
|
||||
- `cms-web:<tag>`
|
||||
- `cms-admin:<tag>`
|
||||
2. In Gitea Actions, run `CMS Deploy` workflow.
|
||||
3. Inputs:
|
||||
- `environment=staging`
|
||||
- `image_tag=<tag>`
|
||||
- `rollback_tag=` (empty for normal deploy)
|
||||
4. Confirm workflow success.
|
||||
5. Validate staging endpoints:
|
||||
- web base route
|
||||
- admin login route
|
||||
6. Run smoke checks on staging:
|
||||
- auth login
|
||||
- i18n route/switch baseline
|
||||
- admin dashboard route access
|
||||
7. If failure:
|
||||
- rerun `CMS Deploy` with `rollback_tag=<previous-tag>`
|
||||
- capture root cause and remediation notes
|
||||
|
||||
## Evidence To Capture
|
||||
|
||||
- Workflow run URL
|
||||
- Deployed image tag
|
||||
- Timestamp (UTC)
|
||||
- Validation results (pass/fail)
|
||||
- Rollback performed or not
|
||||
|
||||
## Deployment Record Template
|
||||
|
||||
Copy the block below into a new file under `docs/product-engineering/staging-deployments/`.
|
||||
|
||||
```md
|
||||
# Staging Deployment Record - <YYYY-MM-DD>
|
||||
|
||||
- Date (UTC):
|
||||
- Operator:
|
||||
- Workflow run URL:
|
||||
- Target environment: staging
|
||||
- Image tag:
|
||||
- Previous tag:
|
||||
|
||||
## Preconditions
|
||||
|
||||
- [ ] Secrets configured in Gitea
|
||||
- [ ] Registry images available
|
||||
- [ ] Remote compose path verified
|
||||
|
||||
## Execution
|
||||
|
||||
1. Triggered `CMS Deploy` with `environment=staging`, `image_tag=<tag>`
|
||||
2. Workflow status: <!-- pass/fail -->
|
||||
|
||||
## Validation
|
||||
|
||||
- [ ] Web route check
|
||||
- [ ] Admin login route check
|
||||
- [ ] Auth smoke flow
|
||||
- [ ] i18n smoke flow
|
||||
- [ ] Admin dashboard access
|
||||
|
||||
## Rollback
|
||||
|
||||
- Performed: <!-- yes/no -->
|
||||
- Rollback tag:
|
||||
- Rollback workflow run URL:
|
||||
|
||||
## Outcome
|
||||
|
||||
- Result: <!-- success/failed -->
|
||||
- Notes:
|
||||
- Follow-up actions:
|
||||
```
|
||||
Reference in New Issue
Block a user