Skip to content

release-checklist.md

Latest commit

 

History

History
71 lines (49 loc) · 1.47 KB

release-checklist.md

File metadata and controls

71 lines (49 loc) · 1.47 KB

Release Checklist

Use this before tagging a new version.

Release policy:

  • publish core artifacts only (deterministic/default build)
  • do not publish experimental artifacts

1. Build and Unit Test

./mvnw clean test
./mvnw -DskipTests package

Core contract gate:

./scripts/run-core-contract-check.sh

2. Run Pre-Release Smoke

Deterministic core-only gate:

CLI_MODE=jar SMOKE_FAIL_ON_REGRESSION=1 ./scripts/run-cli-prebuild-smoke.sh

This run already includes:

  • command help matrix (RUN_COMMAND_MATRIX=1)
  • functional matrix (RUN_FUNCTIONAL_MATRIX=1)
  • standalone matrix (RUN_STANDALONE_MATRIX=1)

Full environment path (heavy):

CLI_MODE=jar RUN_SETUP_DEV_ENV_FULL=1 SMOKE_FAIL_ON_REGRESSION=1 ./scripts/run-cli-prebuild-smoke.sh

Optional experimental extension (non-release signal):

CLI_MODE=jar RUN_AI_STEPS=1 ./scripts/run-cli-prebuild-smoke.sh

3. Review Smoke Artifacts

Check:

  • reports/index.md
  • reports/summary.tsv
  • unexpected FAIL steps (must be zero)

XFAIL can be acceptable only when explicitly expected.

4. Validate Docs and Command Surface

Confirm:

  • README.md quick-start commands still work
  • docs/reference/core-contract.md still matches implemented core behavior
  • docs/reference/commands.md matches current CLI
  • docs/reference/configuration.md matches config behavior

5. Tag and Publish

git tag vX.Y.Z
git push --tags

Tag push triggers release automation.