From 4357a2ba7369399eb9c898d35a2e64ac611ce7d9 Mon Sep 17 00:00:00 2001 From: hermes Date: Fri, 16 Oct 2026 10:01:47 +0000 Subject: [PATCH] docs: release notes format in the release order Notes in the style of other open-source releases: an upgrade line when urgent, New Features / Bug Fixes / Improvements with one user-facing sentence and PR numbers per item, and a Full Changelog compare link. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01V3syn2fN2LNo5pvTSqc6eh --- docs/NPM_DISTRIBUTION.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/NPM_DISTRIBUTION.md b/docs/NPM_DISTRIBUTION.md index d052bb6..e04345b 100644 --- a/docs/NPM_DISTRIBUTION.md +++ b/docs/NPM_DISTRIBUTION.md @@ -119,7 +119,14 @@ Release order: 2. Push the tag, or run the workflow for an existing tag. 3. Publish the crates from the tagged commit, dependency first: `cargo publish -p idx-core`, then `-p idx-cli` and `-p idx-mcp`. -4. Confirm the release has all eight binaries plus `SHA256SUMS`. +4. Confirm the release has all eight binaries plus `SHA256SUMS`, then write + its notes (`gh release edit vX.Y.Z --notes-file `; the workflow + creates the release without them). Open with a one-line upgrade note when + a fix is urgent, then `## New Features`, `## Bug Fixes`, `## Improvements` + (and `## Testing` or `## Docs` when useful): one user-facing sentence per + item, ending with the PR or issue numbers, e.g. `(#46)`. Omit empty + sections, and end with + `**Full Changelog**: https://github.com/0xrsydn/idx-cli/compare/...`. 5. Run `npm publish` in the repo root and in `npm/idx-mcp/` from the tagged commit. The account has two-factor auth, so npm asks for a browser approval or `--otp=`.