Skip to content

Automate npm release docs, pack verification, and provenance - #133

Merged
jeremymcs merged 3 commits into
mainfrom
cursor/npm-release-readme-fb05
Sep 20, 2026
Merged

jeremymcs merged 3 commits into
mainfrom
cursor/npm-release-readme-fb05

Conversation

@jeremymcs

@jeremymcs jeremymcs commented Sep 20, 2026

Copy link
Copy Markdown
Member

Summary

Enhances the Release workflow with automated changelog/README updates, npm publishing best practices, and conventional-commit auto version bumping.

Auto version bump

  • scripts/bump_version.mjs — derives next semver from commits since the previous v* tag:
    • BREAKING CHANGE / type!:major (1.1.02.0.0)
    • feat:minor (1.1.01.2.0)
    • fix: / perf:patch (1.1.01.1.1)
  • Manual Release dispatch can leave version empty and choose auto / major / minor / patch
  • Workflow commits the bump to main, then verifies, publishes, and tags
  • Tag pushes still require package.json to already match the tag

Release docs + publish hardening

  • Updates CHANGELOG.md + README release block before publish
  • npm pack --dry-run in CI and release
  • npm publish --provenance
  • Syncs docs back to main; GitHub Release notes from changelog

Preview locally

node scripts/bump_version.mjs --bump auto --dry-run   # currently -> 1.2.0 (minor)
node scripts/bump_version.mjs --bump major --dry-run  # -> 2.0.0
node scripts/update_release_docs.mjs --version 1.2.0 --dry-run

Test plan

  • npm test (89 tests pass)
  • node scripts/bump_version.mjs --bump auto --dry-run on current main
Open in Web Open in Cursor 

cursoragent and others added 3 commits September 20, 2026 07:15
…shing

Add scripts/update_release_docs.mjs to generate Keep a Changelog entries from
git history and refresh the README release-docs block. The Release workflow now
updates CHANGELOG.md and README before publish, dry-runs npm pack, publishes
with npm provenance, syncs docs back to main, and uses changelog content for
GitHub Release notes. CI verifies npm pack on Node 20.

Co-authored-by: Jeremy McSpadden <jeremy@fluxlabs.net>
…eases

Introduce scripts/bump_version.mjs to derive the next semver from commits
since the previous v* tag (breaking -> major, feat -> minor, fix/perf ->
patch) or from an explicit bump input. Manual Release dispatch can now omit
version and choose auto/major/minor/patch; the workflow commits the bump to
main before verify and publish. Tag pushes still require a pre-bumped
package.json.

Co-authored-by: Jeremy McSpadden <jeremy@fluxlabs.net>
…ertions

Disable history recording in the ServeTests fixture and stop the background
poll thread on teardown. test_activity now asserts the seeded phase-changed
event instead of the full history length, removing a CI flake where the first
poll appended a project-added record before the assertion ran.

Co-authored-by: Jeremy McSpadden <jeremy@fluxlabs.net>
@jeremymcs
jeremymcs marked this pull request as ready for review September 20, 2026 08:32
@jeremymcs
jeremymcs merged commit 3d445af into main Sep 20, 2026
7 checks passed
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.

2 participants