Skip to content

Crown0815/ConventionalChangelog

Repository files navigation

Conventional Changelog

Conventional Commits

Conventional Changelog is a CLI-tool to generate a changelog from conventional commits.

Main features:

  • Changelog generation from conventional commits
  • Changelog fine-tuning using commit relationships
  • Changelog corrections by overriding commit messages
  • Deep customization of keywords (coming soon)

Getting Started

Install conventional changelog using

dotnet tool install --global ConventionalChangelog
changelog "/path/to/repository" --output "changelog.md"

Inspiration

This tool was inspired by ap0llo/changelog.

Acknowledgements

Thank you to

  • Cocona for providing a great CLI framework

About

ConventionalChangelog is a powerful, lightweight CLI tool built in C#, automating changelog generation from conventional commits in Git repos. Run with one command for structured logs highlighting features, fixes, and breaks. Supports commit relationships, message overrides, and hash display. Ideal for SemVer compliance and consistent docs.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages