Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
30 changes: 30 additions & 0 deletions docs/release-readiness.md
Original file line number Diff line number Diff line change
@@ -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.