Skip to content

chore(release): integrate standard-version for releases - #3

Merged
Puppo merged 1 commit into
mainfrom
chore/standard-version
Jun 9, 2026
Merged

Puppo merged 1 commit into
mainfrom
chore/standard-version

Conversation

@Puppo

@Puppo Puppo commented Jun 9, 2026

Copy link
Copy Markdown
Member

Add standard-version as a devDependency and wire it into npm scripts for cutting releases.

Changes

  • Add standard-version@^9.5.0 as a devDependency.
  • Expose three release scripts in package.json:
    • npm run release — bump package.json, regenerate CHANGELOG.md, create the vX.Y.Z tag.
    • npm run release:dry — preview the bump, changelog, and tag without writing.
    • npm run release:first — tag the initial release without re-bumping.
  • Document the release flow in the README.md (dry-run → release → push tag → npm publish), plus a short note on --release-as for forcing a specific SemVer bump.
  • No config file is added; standard-version's defaults fit this project (single package.json as the bump file, GitHub commit URLs inferred from repository.url, vX.Y.Z tag prefix).

Verification

  • npm run release:dry runs cleanly and correctly infers the Conventional Commits preset and the next bump from the current commit history.
  • pre-commit (eslint + npm test) and commit-msg (commitlint) hooks pass on the integration commit.

Notes

  • No CHANGELOG.md is generated or committed by this PR — the first entry will be produced by whoever runs the first npm run release after this is merged.
  • The project also lacks a GitHub Actions workflow to publish on tag push; happy to add that in a follow-up if you want releases to flow end-to-end.

Add standard-version as a devDependency and expose three release scripts:
- npm run release      bumps the version, regenerates CHANGELOG.md, and tags.
- npm run release:dry  previews the bump, changelog, and tag without writing.
- npm run release:first tags the initial release without re-bumping.

Document the release flow in the README (dry-run first, then release, push
the tag, then npm publish), along with a note on --release-as for forcing
a specific SemVer bump.
@Puppo
Puppo marked this pull request as ready for review June 9, 2026 19:21
@Puppo
Puppo merged commit 616d37a into main Jun 9, 2026
16 checks passed
@Puppo
Puppo deleted the chore/standard-version branch June 9, 2026 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant