Home

Awesome

:bulb: commit-analyzer-cz

CI Go Report Card PkgGoDev

A Conventional Commits analyzer for go-semantic-release.

How the commit messages are analyzed

Bump major version (0.1.2 -> 1.0.0)

Bump minor version (0.1.2 -> 0.2.0)

Bump patch version (0.1.2 -> 0.1.3)

Customizable Release Rules

It is possible to customize the release rules by providing options to the analyzer. The following options are available:

OptionDefault
major_release_rules*!
minor_release_rulesfeat
patch_release_rulesfix

⚠️ Commits that contain BREAKING CHANGE(S) in their body will always result in a major release. This behavior cannot be customized yet.

Rule Syntax

A rule may match a specific commit type, scope or both. The following syntax is supported: <type>(<scope>)<modifier>

Example Rules

Commitfeat (or feat(*)*! (or *(*)!)chore(deps)*🚀
feat(ui): add button component
feat!: drop support for Go 1.17
chore(deps): update dependencies
refactor: remove unused code
fix🚀: correct minor typos

References

Licence

The MIT License (MIT)

Copyright © 2024 Christoph Witzko