Release Readiness Checklist

Purpose

Provide the mandatory go or no-go checklist before creating a DSAMbayes release tag.

How to use this checklist

  1. Complete this checklist after running all release-quality gates.
  2. Record evidence paths for each item.
  3. If any mandatory item fails, decision is NO-GO.
  4. Copy final decision details into Release Sign-off Template.

Mandatory checklist

ID Check Pass criteria Evidence required
RL-01 Candidate commit fixed Single candidate commit hash selected and recorded 00_release_identity/release_identity.txt
RL-02 Version metadata aligned DESCRIPTION version equals intended release version 00_release_identity/release_identity.txt
RL-03 Changelog aligned Top CHANGELOG.md section matches candidate scope 00_release_identity/changelog_top.md
RL-04 QG-1 lint passed Exit code 0, no lint failures 10_quality_gates/qg1_lint.log, 10_quality_gates/qg1_lint.exit
RL-05 QG-2 style passed Exit code 0, no style failures 10_quality_gates/qg2_style.log, 10_quality_gates/qg2_style.exit
RL-06 QG-3 tests passed Exit code 0, no test failures 10_quality_gates/qg3_tests.log, 10_quality_gates/qg3_tests.exit
RL-07 QG-4 package check passed No ERROR; no unresolved WARNING 10_quality_gates/qg4_rcmdcheck.log, 10_quality_gates/qg4_rcmdcheck.exit
RL-08 QG-5 validate passed Exit code 0; required validate artefacts present 10_quality_gates/qg5_validate.*, 20_runner_artifacts/quality_gate_validate/
RL-09 QG-6 run passed Exit code 0; required run artefacts present 10_quality_gates/qg6_run.*, 20_runner_artifacts/quality_gate_run/
RL-10 QG-7 docs build passed Exit code 0; pkgdown build completed 10_quality_gates/qg7_pkgdown.*
RL-11 CI package workflow green .github/workflows/R-CMD-check.yaml passed on candidate commit 30_ci/ci_run_summary.md
RL-12 CI docs workflow green .github/workflows/pkgdown.yaml build passed on candidate commit 30_ci/ci_run_summary.md
RL-13 Evidence bundle complete All mandatory evidence items EVD-01 to EVD-13 present Evidence root directory
RL-14 Exceptions resolved or accepted All exceptions documented with owner and approval 40_signoff/sign_off_record.md
RL-15 Final sign-off recorded Decision, approver, and timestamp completed 40_signoff/sign_off_record.md

Required runner artefact checks

Validate artefacts that must exist:

  1. 20_runner_artifacts/quality_gate_validate/00_run_metadata/config.original.yaml
  2. 20_runner_artifacts/quality_gate_validate/00_run_metadata/config.resolved.yaml
  3. 20_runner_artifacts/quality_gate_validate/00_run_metadata/session_info.txt

Run artefacts that must exist:

  1. 20_runner_artifacts/quality_gate_run/00_run_metadata/config.resolved.yaml
  2. 20_runner_artifacts/quality_gate_run/20_model_fit/model.rds
  3. 20_runner_artifacts/quality_gate_run/30_post_run/posterior_summary.csv
  4. 20_runner_artifacts/quality_gate_run/40_diagnostics/diagnostics_report.csv

Decision rules

  1. GO only if every checklist item RL-01 to RL-15 passes.
  2. NO-GO if any mandatory item fails or evidence is incomplete.
  3. HOLD if no hard failure exists but final approval is pending.
  4. Tag creation is allowed only after GO decision is recorded.

Completion record template

Use this section when running the checklist.

Field Value
Release version <fill>
Candidate commit hash <fill>
Checklist executor <fill>
Checklist completion date (UTC) <YYYY-MM-DD>
Checklist result (GO/NO-GO/HOLD) <fill>
Evidence root path <fill>
Sign-off record path <fill>

Audit continuity reference

For programme-level historical traceability, also review:

  • refactoring_plan/release_readiness_checklist_v1.2.md

This page is the operational checklist for current release execution.