Release Process

This project enforces one markdown release note file per released version.

Rule

For every release version X.Y.Z, create:

• docs/releases/vX.Y.Z.md

The file is tracked in git and serves as the version-control release artifact.

Standard Flow

1. Bump version with npm:
   • Patch: npm version patch
   • Minor: npm version minor
   • Major: npm version major
2. The version script auto-runs:
   • node scripts/release/create-release-notes.js --stage
   • Generates docs/releases/vX.Y.Z.md if missing
   • Updates docs/releases/README.md index
   • Stages generated files for the release commit
3. Review and edit the generated markdown before pushing.
4. Push code and tags:
   • git push origin main --follow-tags

Manual Commands

• Generate/update release notes for current package version:
  • npm run release:notes
• Validate that current version has a release note file:
  • npm run release:check

Notes

• If the release note file already exists, it is preserved (not overwritten).
• Use --force only if you intentionally want to regenerate:
  • node scripts/release/create-release-notes.js --force