docs: add CHANGELOG, automate release notes, refresh README#97
docs: add CHANGELOG, automate release notes, refresh README#97coderdan wants to merge 2 commits into
Conversation
Seed a Keep a Changelog-format CHANGELOG.md with the upcoming 0.25.0 entry and backfill the recent 0.22.0, 0.23.0, and 0.24.0 releases from git history. Notes the pre-1.0 convention that breaking changes ship as minor bumps.
|
Warning Review limit reached
More reviews will be available in 13 minutes and 17 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
- Add an [Unreleased] section + maintenance note to CHANGELOG.md. - scripts/changelog-release.mjs promotes [Unreleased] to a dated entry during the existing 'version' npm lifecycle hook (staged by its trailing 'git add .'), so the tagged commit always carries an updated CHANGELOG. Defensive: skips cleanly on missing version / section / already-promoted so a release is never blocked. - scripts/changelog-extract.mjs prints a version's section; the release workflow's main job uses it as the GitHub release notes body (body_path), falling back to a CHANGELOG link if absent. - README: document the automation, the @cipherstash/stack rename, and 'npx stash auth login' for local setup.
coderdan
changed the title
1 participant
Adds a
CHANGELOG.md(the repo had none), automates changelog/release-notes upkeep, and refreshes the stale README.CHANGELOG
CHANGELOG.mdin Keep a Changelog format, with0.25.0seeded and0.24.0/0.23.0/0.22.0backfilled from git history.[Unreleased]section is the place contributors add notes.Release-notes automation
scripts/changelog-release.mjsruns inside the existingversionnpm lifecycle hook (neon bump … && node scripts/changelog-release.mjs && git add .). Onnpm versionit promotes[Unreleased]to a dated entry and updates the compare links — so the tagged release commit always carries an up-to-date CHANGELOG. Norelease.ymlchanges needed.scripts/changelog-extract.mjsprints a version's section; the release workflow'smainjob feeds it tosoftprops/action-gh-releaseviabody_path, so GitHub release notes come straight from the CHANGELOG (falls back to a CHANGELOG link if the section is missing — never blocks a release).0.26.0bump (empty + populated[Unreleased], idempotency, missing-version).README
@cipherstash/stackpackage (formerly Protect.js).npx stash auth logininstead of the brew-installed RuststashCLI.Validation note
The
version-hook promotion is exercised by anynpm version(including a release dry run). Thebody_pathrelease-notes wiring only runs on a real publish, so it'll be first exercised on the next actual release.(0.25.0 was released manually; its notes were added by hand. This makes the next release automatic.)