Release checklist
Used in the playbook Quality and release.
Download release-checklist.md — the source, as in the repository.
How to use
The template's own instructions:
UASK Engineering Hub template · release-checklist 0.1.0 · playbook quality.quality-release (R9–R23) · CC BY 4.0 Copy once per release, for example to releases/vX.Y.Z.md, or paste into the release pull request. Fill it in BEFORE deploying (sections 1–6), then during and after (7–9). Keep it as the release record (R21). Hotfix lane: steps marked [hotfix: shortened] may be shortened for a hotfix (R22); all other steps are never skipped. Operating systems: also fill in the SCF release record (scf.release-record-template). Delete these comments in the copy.
Fields
Front-matter fields and sections of the document the template creates. A section marked Optional in the template may be deleted from a copy; every other field and section stays (tools/check_artifacts.py checks this for the kinds it knows).
| Field or section | Where | Required |
|---|---|---|
| 1. Scope | section | required |
| 2. Readiness | section | required |
| 3. Deploy plan | section | required |
| 4. Backup (before deploy) | section | required |
| 5. Rollback plan | section | required |
| 6. Approval | section | required |
| 7. Deploy log | section | required |
| 8. Post-release verification | section | required |
| 9. Outcome | section | required |
Example
A filled-in copy for an invented product, templates/examples/release-checklist.md, in the Hub repository.It shows the level of detail to aim for, not text to reuse.
# Release v1.1.0 — Fieldnotes
Type: regular · Prepared by: the lead agent · Approver: Alex Doe · Planned window: 2026-07-06 10:00–10:30 UTC
## 1. Scope
- Version: `v1.1.0` (previous: `v1.0.0`), class: MINOR — why: new export screen, nothing removed- Changelog entry: CHANGELOG.md, section `[1.1.0]`- Breaking changes and upgrade steps: none- Stored data changes (migrations, imports, settings): none — reversible? yes
## 2. Readiness
- [x] Main is green at commit `4f2a9c1`; the tag will point to it.- [x] Artefacts built by CI from the tag (job 812); checksums recorded below.- [x] Staging verification done; results: all critical paths pass on the test channel.- [x] Acceptance by owner or users: Alex Doe, 2026-07-03.- [x] Dependency audit run (`npm audit --omit=dev`); no known exploited vulnerabilities.- [x] Documentation and changelog updated.
| Artefact | SHA-256 ||---|---|| `fieldnotes-1.1.0.apk` | `9b1c…e07a` |
## 3. Deploy plan
- Window: 10:00–10:30 UTC — chosen from: store statistics, lowest weekday activity.- Who deploys: the lead agent · who can roll back during the window: Alex Doe- Steps: 1. none — no maintenance mode 2. promote the build from the test channel to production 3. no migrations 4. none- Expected duration: 10 minutes · Users informed: release notes in the store
## 4. Backup (before deploy)
- What: not applicable, the app stores nothing on a server- Where: — · Taken at: — · Size checked: —- Restore command or procedure: the previous package stays in the store history
## 5. Rollback plan
- Triggers — roll back if any is true during verification: - a critical path fails - the crash rate is above 1 % for 30 minutes- Steps: promote the `v1.0.0` build again; no data change to undo.- Expected time: 10 minutes · Decides: Alex Doe
## 6. Approval
- [x] Approved against this checklist by Alex Doe on 2026-07-06 09:50. A green pipeline alone is not approval.
## 7. Deploy log
- Started: 10:02 · Finished: 10:09- Deviations from the plan: none
## 8. Post-release verification
| Critical path (from the test strategy) | Result ||---|---|| write a note in flight mode, kill the app, reopen | pass || sync two devices | pass |
- [x] Error logs read: none- [x] Monitoring watched for 2 hours: no crash above baseline
## 9. Outcome
- Result: verified- Follow-up issues: none · Regression tests added: none- Record kept at: this fileCompletion checks
A copy is complete when:
- every required field and section above is present, in the same order, and no bracketed placeholder is left;
- the template's comments are deleted from the copy;
- the exit criteria of its stage of the playbook Quality and release are met;
- the owner has approved it, where the playbook asks for approval. Only the owner sets
approved.
Source
templates/release-checklist.md, as in the repository. Placeholders are in square brackets; comments carry the instructions.
<!-- UASK Engineering Hub template · release-checklist 0.1.0 · playbook quality.quality-release (R9–R23) · CC BY 4.0 Copy once per release, for example to releases/vX.Y.Z.md, or paste into the release pull request. Fill it in BEFORE deploying (sections 1–6), then during and after (7–9). Keep it as the release record (R21). Hotfix lane: steps marked [hotfix: shortened] may be shortened for a hotfix (R22); all other steps are never skipped. Operating systems: also fill in the SCF release record (scf.release-record-template). Delete these comments in the copy.-->
# Release vX.Y.Z — [project]
Type: regular / hotfix · Prepared by: [name or agent] · Approver: [name] · Planned window: [YYYY-MM-DD HH:MM–HH:MM TZ]
## 1. Scope
- Version: `vX.Y.Z` (previous: `vA.B.C`), class: MAJOR / MINOR / PATCH — why: [one line]- Changelog entry: [link to the CHANGELOG.md section] [hotfix: shortened — one line is enough]- Breaking changes and upgrade steps: [none / list]- Stored data changes (migrations, imports, settings): [none / list] — reversible? [yes / no]
## 2. Readiness
- [ ] Main is green at commit `<sha>`; the tag will point to it.- [ ] Artefacts built by CI from the tag (`<job link>`); checksums recorded below.- [ ] Staging verification done; results: [link or summary]. [hotfix: shortened — affected path plus critical paths]- [ ] Acceptance by owner or users: [who, when]. [hotfix: shortened — owner confirms the fix]- [ ] Dependency audit run (`<command>`); no known exploited vulnerabilities, or exception: [link].- [ ] Documentation and changelog updated.
| Artefact | SHA-256 ||---|---|| `<file>` | `<checksum>` |
## 3. Deploy plan
- Window: [time] — chosen from: [traffic or load data]. [hotfix: shortened — as soon as approved]- Who deploys: [name or agent] · who can roll back during the window: [name]- Steps: 1. [maintenance mode, if any] 2. [deploy command or procedure] 3. [migrations, cache clear] 4. [leave maintenance mode]- Expected duration: [minutes] · Users informed: [how, if needed]
## 4. Backup (before deploy)
- What: [files / database / configuration]- Where: [location] · Taken at: [time] · Size checked: [size, compared with previous]- Restore command or procedure: [how]
## 5. Rollback plan
- Triggers — roll back if any is true during verification: - [for example: a critical path fails] - [for example: error rate above X % for Y minutes; any fatal error in the log]- Steps: [redeploy vA.B.C artefact; restore data from section 4 if the data change is not reversible]- Expected time: [minutes] · Decides: [approver]
## 6. Approval
- [ ] Approved against this checklist by [name] on [YYYY-MM-DD HH:MM]. A green pipeline alone is not approval.
## 7. Deploy log
- Started: [time] · Finished: [time]- Deviations from the plan: [none / list]
## 8. Post-release verification
| Critical path (from the test strategy) | Result ||---|---|| [path] | pass / fail |
- [ ] Error logs read: [findings]- [ ] Monitoring watched for [observation period]: [findings]
## 9. Outcome
- Result: verified / rolled back / fixed forward by hotfix `<version>`- Follow-up issues: [links] · Regression tests added: [links]- Hotfix only: fix landed on main in [pull request link].- Record kept at: [this file / release page]