Internal (Engineering) — DSAMbayes Documentation

Quality Gates

Mon, 01 Jan 0001 00:00:00 +0000

Purpose Define the canonical release-quality gates for DSAMbayes v1.3.3, including commands, pass/fail criteria, and evidence requirements. Audience Maintainers preparing a release candidate Reviewers signing off release readiness Engineers running local pre-merge quality checks Gate Matrix Gate ID Gate Command Pass Criteria Evidence QG-1 Lint Rscript scripts/check.R --lint Exit code 0, no lint failures, no SKIP: output Terminal log and exit code QG-2 Style Rscript scripts/check.R --style Exit code 0, no style failures, no SKIP: output Terminal log and exit code QG-3 Unit tests Rscript scripts/check.R --test Exit code 0, no test failures Terminal log and exit code QG-4 Stan release evidence Rscript scripts/check.R --stan-release-evidence Exit code 0, high-budget pooled and hierarchical checks pass diagnostic thresholds Terminal log and exit code QG-5 Package check _R_CHECK_FORCE_SUGGESTS_=false R -q -e 'rcmdcheck::rcmdcheck(args = c("--no-manual"), error_on = "warning")' No ERROR. No unresolved WARNING for release sign-off. Any NOTE requires explicit reviewer acceptance rcmdcheck summary and reviewer decision on NOTEs QG-6 Runner smoke: validate Rscript scripts/dsambayes.R validate --config config/blm_timeseries.yaml --run-dir results/quality_gate_validate Exit code 0 CLI log and results/quality_gate_validate/00_run_metadata/config.compiled.yaml QG-7 Runner smoke: run Rscript scripts/dsambayes.R run --config config/blm_timeseries.yaml --run-dir results/quality_gate_run Exit code 0 and core artefacts exist CLI log and selected artefacts under results/quality_gate_run/ QG-8 Docs build check python3 docs-site/build_content.py && (cd docs-site && hugo --cleanDestinationDir) Exit code 0 Build log and generated site output under docs-site/public/ Gate Definitions QG-1 Lint Command:

Testing and Validation

Mon, 01 Jan 0001 00:00:00 +0000

Purpose Define the canonical testing and validation workflow for DSAMbayes v1.3.3, from local pre-merge checks through release-quality gates. Audience Engineers running local checks before merge Maintainers preparing release candidates Reviewers validating release evidence Validation layers Layer Objective Primary command(s) Output proof Lint Catch style and static issues early Rscript scripts/check.R --lint Exit code 0, no lint failures Style Enforce formatting compliance on changed files Rscript scripts/check.R --style Exit code 0, no reformat-required files Unit tests Catch behavioural regressions in package logic Rscript scripts/check.R --test Exit code 0, no test failures Minimal smoke Keep a cheap Stan-backed safety check in the routine local loop Rscript scripts/check.R --smoke Exit code 0, fast unit tests plus minimal Stan smoke pass Stan smoke Exercise the broader compiled Stan suite beyond the minimal smoke tier Rscript scripts/check.R --stan-smoke Exit code 0, Stan smoke tests enabled Stan recovery evidence Re-run the full coefficient-recovery file under the nightly Stan gate Rscript scripts/check.R --stan-recovery Exit code 0, full-Stan DGP recovery tests pass Stan release evidence Re-run high-budget pooled and hierarchical evidence checks for release candidates Rscript scripts/check.R --stan-release-evidence Exit code 0, targeted high-budget Stan evidence passes diagnostic thresholds Docs sanity Catch local docs-link breakage and high-value contract drift Rscript scripts/check.R --docs Exit code 0, docs sanity checks pass Package check Validate package-level install and check behaviour R -q -e 'rcmdcheck::rcmdcheck(...)' No ERROR; no unresolved WARNING Runner validate Validate config and data contracts without fitting Rscript scripts/dsambayes.R validate ... Exit code 0, metadata artefacts Runner run Validate end-to-end runner execution and artefacts Rscript scripts/dsambayes.R run ... Exit code 0, core run artefacts Docs build Validate docs-site/Hugo buildability python3 docs-site/build_content.py && (cd docs-site && hugo --cleanDestinationDir) Exit code 0, successful site build Environment setup Run all commands from repository root:

Runner Smoke Tests

Mon, 01 Jan 0001 00:00:00 +0000

Purpose Define the minimal reproducible smoke-test matrix for the YAML runner validate and run commands, including exact commands and expected artefacts. Audience Maintainers preparing release evidence Engineers triaging runner regressions Reviewers confirming gate QG-5 and QG-6 Test scope This smoke suite is intentionally small. It proves:

Repository Size Cleanup

Mon, 01 Jan 0001 00:00:00 +0000

Current state Local inspection on 2026-04-04 found: .git size: about 1.4G packed objects: about 1.35 GiB loose objects: 0 garbage objects: 0 This means the size is in committed history, not in disposable local Git metadata. Largest historical contributors found so far: results/: about 635 MiB .Rlib/: about 444 MiB .cache/: about 279 MiB assets/: about 183 MiB code_review/: about 125 MiB Largest file classes found so far:

Release Evidence Pack

Mon, 01 Jan 0001 00:00:00 +0000

Purpose Define the exact evidence bundle required before manual DSAMbayes release sign-off. Substitute the actual release version and candidate SHA; this page is not version-specific. Audience Release owner preparing sign-off materials Reviewers validating release readiness Maintainers reproducing release gate outcomes Evidence root and naming Use one evidence root per candidate release.

Release Readiness Checklist

Mon, 01 Jan 0001 00:00:00 +0000

Purpose Provide the mandatory go or no-go checklist before manually creating a DSAMbayes release tag. It supports the normal quarterly release cycle; it does not require CI/CD or a rapid release cadence. How to use this checklist Complete this checklist after running all release-quality gates. Record evidence paths for each item. If any mandatory item fails, decision is NO-GO. 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, with matching sign-off metadata 00_release_identity/release_identity.txt, 40_signoff/sign_off_record.md 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 Stan release evidence passed Exit code 0; diagnostic thresholds passed 10_quality_gates/qg4_stan_release_evidence.* RL-08 QG-5 package check passed No ERROR; no unresolved WARNING 10_quality_gates/qg5_rcmdcheck.log, 10_quality_gates/qg5_rcmdcheck.exit RL-09 QG-6 validate passed Exit code 0; required validate artefacts present 10_quality_gates/qg6_validate.*, 20_runner_artifacts/quality_gate_validate/ RL-10 QG-7 run passed Exit code 0; required run artefacts present 10_quality_gates/qg7_run.*, 20_runner_artifacts/quality_gate_run/ RL-11 QG-8 docs build passed Exit code 0; docs-site build completed 10_quality_gates/qg8_docs.* RL-12 Dependency sources recorded Non-CRAN and file:// dependency sources, revisions, and portability decisions are recorded; no credentials are included 00_release_identity/dependency_sources.md RL-13 Evidence bundle complete All mandatory evidence items 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:

Release Playbook

Mon, 01 Jan 0001 00:00:00 +0000

Purpose Define the deliberate, evidence-led release process for DSAMbayes. It supports the normal quarterly release cycle and material ad-hoc releases. It is not a CI/CD process and does not imply continuous deployment or a high release cadence. The point is to make the infrequent release decision reproducible and reviewable, not to automate it for its own sake.

Sign-off Template

Mon, 01 Jan 0001 00:00:00 +0000

Purpose Provide the final approval record for a DSAMbayes release candidate after all mandatory evidence has been reviewed. Instructions Copy this template into the candidate evidence bundle as 40_signoff/sign_off_record.md. Complete every field. Use GO, NO-GO, or HOLD for the decision. If any exception is accepted, record explicit rationale and owner. Copy the candidate commit hash and evidence-root path directly from 00_release_identity/release_identity.txt; do not introduce a second candidate hash during sign-off. Release identification Field Value Release version vX.Y.Z Package version (DESCRIPTION) Candidate commit hash Candidate branch Intended tag R version and platform Container image/digest (if used) DSAMdecomp source and revision Changelog section verified Evidence root path Decision summary Field Value Decision Decision date (UTC) Decision timestamp (UTC) Release owner Primary approver Secondary reviewer (if used) Decision rationale: