Open source · DevOps & Release

Changelog Fragment Checker

Check changelog fragments for required scope, links and release ownership.

v1.0.0 · Node.js 22+ · MIT

Browse the public repository · View releases

Offline, read-only validation of exported changelog fragments against a complete local package manifest. It assembles a deterministic preview; it never publishes a tag or release.

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/changelog-fragment-checker.mjs --root examples/pass --manifest manifest.json --fragments fragments.json
node bin/changelog-fragment-checker.mjs --root examples/fail --manifest manifest.json --fragments fragments.json
npm run check

Read the result

The CLI prints one JSON report. Exit 0=pass, 1=fail, 2=incomplete or invalid configuration. Invalid options, root, or manifest produce empty stdout. Unreadable, malformed, or invalid UTF-8 fragment input produces an incomplete report. Both named files are realpath-confined beneath --root; neither is modified. Duplicate decoded JSON keys (including escaped spellings) are rejected.

Where this check stops

Manifest ≤65,536 bytes; bundle ≤524,288 bytes; at most 1,000 packages, 1,000 fragments, and 20 issues per fragment; JSON depth ≤16; evaluation ≤5,000 ms with an injectable monotonic clock. Each documented bound accepts N and rejects N+1 as incomplete; a malformed issue reference within the limit is a failure.

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.