Release runbook
Repeatable steps to verify, tag, publish to npm and confirm a release. Written for the maintainer.
Pre-release checklist
npm testpasses locally.npm run benchmarkreports no false positives or negatives.npm run build:skills && npm run build:evidenceproduce no unexpected diffs.node scripts/build-documents.mjsregenerates the HTML documentation.CHANGELOG.mdhas an entry;package.json,CITATION.cffcarry the same version.- CI is green on Linux, Windows and macOS.
npm pack --dry-runlists only intended files and no secrets.
Publish to npm (manual)
npm login
npm publish --access public
npm may require a one-time password (2FA). Never paste tokens into chat, files or issues; use npm login or a CI secret.
Publish to npm (CI with provenance)
Create an npm automation token, add it as repository secret NPM_TOKEN, then publish a GitHub Release. The workflow .github/workflows/publish.yml runs the tests and executes npm publish --provenance.
Verify the published package
npx docsutra-ai@latest version
npx docsutra-ai@latest doctor
GitHub release
git tag v0.2.1
git push origin v0.2.1
gh release create v0.2.1 --title "v0.2.1" --notes-file CHANGELOG.md
After release
- Confirm the npm page and the README render.
- Add repository topics and a description so people and search engines can find it.
- Rotate any credential that was ever shared outside a secret store.
Rollback
npm versions are immutable. Fix forward with a patch release; deprecate the bad version with npm deprecate.