Open source · DevOps & Release

Release Notes Diff

Compare release notes with commits, issues and user-visible change categories.

v0.1.0 · Node.js 22+ · MIT

Browse the public repository · View releases

Offline, read-only comparison of local exported commit metadata, issue context and release-note entries. It never runs Git, queries an issue tracker, publishes notes, or generates prose. The export must be complete and must give explicit change IDs/categories; missing context stays unknown.

This walkthrough uses the tool's public README and checked-in example files. Run the command from a repository checkout with Node.js 22+; inspect the source before using it on your own files.

Run the checked-in example

node bin/release-notes-diff.mjs --root examples --input passing.json
node bin/release-notes-diff.mjs --root examples --input failing.json
npm run check

Read the result

--root confines reads by real path; --input is relative within it. Optional --human prints one summary to stderr. Stdout is only JSON. No output file is written. Bad arguments/configuration: exit 2, empty stdout. Unreadable/invalid/incomplete evidence: incomplete JSON, exit 2. Evaluated omission or unsupported claim: fail, exit 1. Evaluated agreement: pass, exit 0.

Where this check stops

1,048,576 UTF-8 bytes; 100 records in each of commits/issues/notes; JSON depth 4 from root depth 0; 5,000 ms on an injectable library clock. Exact N accepted, N+1 incomplete. Strict UTF-8 and duplicate-key rejection (including escaped keys) prevent ambiguous evidence. CLI read has a 5-second abort. No network, Git execution, tracker query, text drafting, publication, or auto-fix.

Before adapting the command to your own workflow, review the accepted inputs, exit codes and safety boundaries in the README.

Compiled with AI assistance from checked-in public documentation and example scripts. Run the example and review the repository's current documentation before relying on its result.