changelog-generator

Generates release notes from Git tags and Conventional Commit messages.

• Tag-based release grouping.
• Breaking-change extraction.
• Repository and pull-request links.
• Configurable output.

Prerequisites: Node.js >=18 and npm; Git is also used by the implementation. The checkout below pins the source used for this documentation.

git clone https://github.com/NickCirv/changelog-generator.git
cd changelog-generator
git checkout bfe924fd9b784145daef9a99dd090fad7d8d61bd
node index.js --format markdown

Expected behavior (illustrative, not captured): Prints Markdown release notes derived from available Git history and tags.

Examples are source-inspected, not runtime-tested. See the research record for verification gaps.

Classification depends on commit-message discipline and available Git tags. Review breaking-change notes and links before publication. Output flags may write files.

The manifest defines npm test as:

node --test

The captured suite is a smoke check, not end-to-end behavior coverage. Examples include “entry is valid JavaScript”, “--help exits 0”. Tests were not run for this documentation revision.

See implementation and command reference for the package scripts and inspected interfaces, and research record for the pinned source, document decisions and unresolved checks.

See LICENSE for the original terms and attribution. Legal text is unchanged.

Nicholas Ashkar · Discuss a project