haunt98/changeloguru

Created Dec 30, 2020 · View the haunt98/changeloguru repository page

Tool to generate CHANGELOG.md from Conventional Commits.

Want this for your repo?

Render a free sample of any GitHub repo in seconds.

Visualize your own →

Contributors

2

Lines of Code

202

From

Oct 6, 2020

To

Dec 29, 2020

About haunt98/changeloguru

Changeloguru is a Go tool that automatically generates changelog files from Conventional Commits. It supports output in both Markdown and reStructuredText formats, making it flexible for different documentation styles. The tool analyzes git history between two references and organizes commit messages into a structured changelog following the Conventional Commits specification.

The tool uses a straightforward command-line interface with parameters to specify the commit range for changelog generation. Users can define a "from" reference (newer commits) and a "to" reference (older commits) to control which changes are included in the generated output. This makes it easy to extract changelog entries for specific releases or time periods from a project's git history.

Changeloguru is designed for developers who want to automate their release documentation process by leveraging the structure already present in their commit messages. By requiring developers to follow Conventional Commits conventions, the tool can intelligently categorize changes by type and extract meaningful changelog entries without manual editing.

Share this video