0xrsydn/idx-cli
1
mirror of https://github.com/0xrsydn/idx-cli.git synced 2026-11-07 09:45:36 +00:00
Code Issues Projects Releases 1 Packages Wiki Activity

docs: release notes format in the release order

Browse source 
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 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01V3syn2fN2LNo5pvTSqc6eh
This commit is contained in:
hermes 2026-10-16 10:01:47 +00:00
commit 4357a2ba73
1 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/NPM_DISTRIBUTION.md
View file

@ -119,7 +119,14 @@ Release order:
2. Push the tag, or run the workflow for an existing tag. 2. Push the tag, or run the workflow for an existing tag.
3. Publish the crates from the tagged commit, dependency first: 3. Publish the crates from the tagged commit, dependency first:
`cargo publish -p idx-core`, then `-p idx-cli` and `-p idx-mcp`. `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 <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/<previous>...<this>`.
5. Run `npm publish` in the repo root and in `npm/idx-mcp/` from the tagged 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 commit. The account has two-factor auth, so npm asks for a browser
approval or `--otp=<code>`. approval or `--otp=<code>`.