mirror of https://github.com/0xrsydn/idx-cli.git synced 2026-11-07 01:35:36 +00:00

History

0xrsydn eb4e2d4162 fix(changelog): refuse to release a version older than the newest `release 0.4.9` on a changelog topped by 0.5.0 wrote the section above it with a backwards compare link and deleted the entries; `check` caught the file only afterwards (Pullfrog on #82). The version is now compared before anything is written. Also: the #78 entry names the calendar's open offers and the session API's read-path allowlist, added there since. Claude-Session: https://claude.ai/code/session_01RqPPVeVDrnLoP7NUZmLRxY	2026-11-04 20:47:20 +07:00
..
unreleased	fix(changelog): refuse to release a version older than the newest	2026-11-04 20:47:20 +07:00
README.md	docs: keep a CHANGELOG.md, with one entry file per PR	2026-11-04 19:48:58 +07:00

0xrsydn eb4e2d4162 fix(changelog): refuse to release a version older than the newest

`release 0.4.9` on a changelog topped by 0.5.0 wrote the section above it
with a backwards compare link and deleted the entries; `check` caught the
file only afterwards (Pullfrog on #82). The version is now compared before
anything is written.

Also: the #78 entry names the calendar's open offers and the session API's
read-path allowlist, added there since.

Claude-Session: https://claude.ai/code/session_01RqPPVeVDrnLoP7NUZmLRxY

2026-11-04 20:47:20 +07:00

unreleased

fix(changelog): refuse to release a version older than the newest

2026-11-04 20:47:20 +07:00

README.md

docs: keep a CHANGELOG.md, with one entry file per PR

2026-11-04 19:48:58 +07:00

README.md

Changelog entries

Every pull request that changes what users or agents see adds one file here, changes/unreleased/<branch-name>.md; for example, fix/mcp-warnings adds changes/unreleased/mcp-warnings.md. Each PR has its own file, so stacked PRs never conflict over the changelog. Internal refactors, CI-only and test-only changes need no entry.

An entry holds ### <section> headings with one bullet per change. Write each bullet as one sentence for the user, saying what changed for them, and end it with the PR number:

### Bug Fixes

- `ownership import` reads IDX's register from October 2026 on, which adds a `CONTROLLER_OR_AFFILIATE` column. (#79)

The sections, in the order a release lists them:

Section	For
`Security`	vulnerabilities, with what an attacker could do
`New Features`	new commands, tools, flags and providers
`Bug Fixes`	wrong output, crashes, failures
`Improvements`	speed, robustness, help text, distribution
`Output Changes`	any change to JSON fields, MCP results, error codes or exit codes that scripts and agents read; start a breaking one with Breaking:
`Docs`	user-facing documentation
`Testing`	what was verified, when a release needs to say so
`Notes`	dependencies, requirements, known limits

A release may add changes/unreleased/summary.md: a short paragraph with no headings that opens its notes, such as "Upgrade from 0.3.2: ...".

scripts/changelog.sh check (part of nix flake check) validates the entries. At release time, scripts/changelog.sh release X.Y.Z folds them into a new section of CHANGELOG.md and deletes them; edit the section if needed and commit it with the version bump. The release workflow publishes that section as the GitHub release notes.