Skip to content

Add Keep a Changelog, 0.x version bumps and a CI changelog gate - #78

Merged
NinjaLikesCheez merged 1 commit into
mainfrom
cursor/keep-a-changelog-cb43
Oct 10, 2026
Merged

NinjaLikesCheez merged 1 commit into
mainfrom
cursor/keep-a-changelog-cb43

Conversation

@NinjaLikesCheez

@NinjaLikesCheez NinjaLikesCheez commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Adds Keep a Changelog 1.1.0, automatic 0.x version bumps, agent instructions, and a CI gate. Branched from origin/main so this stays separate from capability DMs (#77) and Tailscale (#76).

Changelog

CHANGELOG.md uses Added / Changed / Fixed (and the other Keep a Changelog types), an [Unreleased] section, and compare links. Notable already-shipped phase 1 work is back-ported under 0.1.0 (the current package.json version), dated 2026-10-09 from the latest merge on main (#75). Item dates are merge/commit dates from git.

This PR’s own Unreleased entry is the changelog, bump tooling, and CI gate.

Version bumps

No semantic-release / release-please. just bump reads Unreleased and updates package.json (the single version source /ping already uses) together with moving Unreleased into a dated section:

  • Added → minor (0.1.0 → 0.2.0)
  • Fixed / Changed / other types → patch
  • Never major before 1.0

just bump --commit also commits Release vX.Y.Z and tags it. If v{previous} was never tagged, it tags the parent commit so compare links resolve.

The Release workflow runs that on each push to main (and workflow_dispatch) when Unreleased has notes. The bump commit uses GITHUB_TOKEN, so it does not start another CD run; the next publish shows the new package version.

After this merges, Unreleased has an Added item, so the first bump will be 0.1.0 → 0.2.0.

Agent instructions

AGENTS.md (the only agent instruction file) now requires an Unreleased entry for user-facing or infra changes. Pure chores may apply or request skip-changelog.

CI gate

.github/workflows/changelog.yml fails PRs that do not touch CHANGELOG.md unless the PR has skip-changelog. pull_request types: opened, synchronize, reopened, labeled, unlabeled. Local equivalent: just check-changelog.

Coverage floors are unchanged: changelog tests live under scripts/ and are not added to the src/ coverage include.

Docs

The runbook has a Changelog and versions operator section. README lists the new recipes and CI jobs.

Tests

Extracted gate/bump logic in scripts/changelog.ts with unit tests. Local just check passed (1577 tests).

Did not touch access, identity, or secrets. Did not add release-automation dependencies.

Open in Web Open in Cursor 

Record notable changes in CHANGELOG.md (Keep a Changelog 1.1.0). PRs must
update Unreleased unless labeled skip-changelog. just bump (and a Release
workflow on main) cuts Unreleased into a dated version and bumps
package.json: Added → minor, Fixed/Changed → patch, never major before 1.0.
@NinjaLikesCheez
NinjaLikesCheez marked this pull request as ready for review October 10, 2026 09:07
@NinjaLikesCheez
NinjaLikesCheez merged commit 2900874 into main Oct 10, 2026
6 of 7 checks passed
NinjaLikesCheez added a commit that referenced this pull request Oct 10, 2026
Operator-facing Added/Changed for the mesh HA path. Required after the
Keep a Changelog gate (#78).

This branch was successfully deployed

1 active deployment
dev — 341ffdad Deployed Oct 10, 2026 by NinjaLikesCheez via Plan envs/dev #25
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