diff --git a/CHANGELOG.md b/CHANGELOG.md index 549b311..d6d52aa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,8 @@ format and uses semantic versioning when versioned releases are published. ### Added +- Added a release-readiness checklist for local verification and package review. + - Initial project setup. ## Release Links diff --git a/README.md b/README.md index a048ccb..1f36405 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,10 @@ npm run smoke bash scripts/validate.sh ``` +## Release readiness + +Use [docs/release-readiness.md](docs/release-readiness.md) before opening release PRs or tagging a release. + ## License MIT diff --git a/docs/README.md b/docs/README.md index bea55e4..1fdd192 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,3 +6,7 @@ - `orchestration.json` gives machine-readable factory metadata. Generated audit reports can be written here with `scriptaudit scan . --out docs/SCRIPTS.md`. + +## Contents + +- [Release readiness](release-readiness.md) diff --git a/docs/release-readiness.md b/docs/release-readiness.md new file mode 100644 index 0000000..f9d80ac --- /dev/null +++ b/docs/release-readiness.md @@ -0,0 +1,24 @@ +# Release readiness + +Use this checklist before cutting a release or asking for a release review. + +## Local verification + +```sh +npm install +npm run check +npm run test +npm run smoke +npm run package:smoke +npm run release:check +``` + +## Package contents + +Run `npm run package:smoke` when available and review the dry-run file list for only the built runtime, README, license, and other intentional release assets. + +## Notes + +- Keep README examples aligned with the fixture-backed smoke command. +- Do not publish until CI is green on the release branch. +- Update CHANGELOG.md with user-facing changes before tagging.