From 4dcbcb4ddc2c4e9e5d4f073e36234ed8be48de6d Mon Sep 17 00:00:00 2001 From: Roger Chappel Date: Tue, 16 Jun 2026 06:42:50 +1000 Subject: [PATCH 1/3] Run package smoke checks in CI --- .github/workflows/ci.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 36b5207..18cbb35 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -77,6 +77,7 @@ jobs: npm run check --if-present npm test --if-present npm run build --if-present + npm run package:smoke --if-present npm run smoke --if-present npm run package:smoke --if-present fi @@ -88,6 +89,7 @@ jobs: npm run check --if-present npm test --if-present npm run build --if-present + npm run package:smoke --if-present npm run smoke --if-present npm run package:smoke --if-present fi From d0dc3d7464b657a7a58ca3af3aac460d6b0ad613 Mon Sep 17 00:00:00 2001 From: Roger Chappel Date: Tue, 16 Jun 2026 06:42:50 +1000 Subject: [PATCH 2/3] Document release readiness checklist --- docs/release-readiness.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/release-readiness.md diff --git a/docs/release-readiness.md b/docs/release-readiness.md new file mode 100644 index 0000000..4ce0348 --- /dev/null +++ b/docs/release-readiness.md @@ -0,0 +1,30 @@ +# Release Readiness + +Use this checklist before cutting a release or asking a reviewer to trust the package contents. + +## Public Package Surface + +- Package: `atomcommit` +- Repository: `https://github.com/rogerchappel/atomcommit` +- Published files are controlled by the `files` allowlist in `package.json`. + +## CLI Surface + +- `atomcommit` -> `./src/index.js` + +## Verification Commands + +- `npm run check`: `node --check src/index.js && node --test test/*.test.js` +- `npm run test`: `node --test test/*.test.js` +- `npm run build`: `node --check src/index.js` +- `npm run smoke`: `bash scripts/smoke.sh` +- `npm run package:smoke`: `npm pack --dry-run` +- `npm run release:check`: `npm run check && npm run smoke && npm run package:smoke` + +Run `npm run release:check` when available before opening a release PR. When a command is unavailable, use the closest listed command and record the reason in the PR. + +## Reviewer Notes + +- Confirm README examples still match the CLI or module exports. +- Confirm `npm pack --dry-run` does not include local fixtures, generated logs, or build caches beyond the intended allowlist. +- Confirm GitHub Actions runs the same install and package smoke path used locally. From 423615dc744d8cc2fbea30dc76e94ab4339532ee Mon Sep 17 00:00:00 2001 From: Roger Chappel Date: Tue, 16 Jun 2026 06:42:50 +1000 Subject: [PATCH 3/3] Add README release verification notes --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index f4749ea..bcd40ca 100644 --- a/README.md +++ b/README.md @@ -71,3 +71,12 @@ MIT Run the release-readiness checks that match this package before publishing or opening a release PR. - `npm run build` - compile the package artifacts + +## Release Verification + +Before publishing or tagging a release, run the local verification path that matches CI: + +- `npm run release:check` +- `npm run package:smoke` + +The release checklist in `docs/release-readiness.md` captures the package surface, CLI bins, and reviewer notes for future release PRs.