git-good-commit icon indicating copy to clipboard operation
git-good-commit copied to clipboard

Add support for Sem-Ver pseudo-headers inside commit messages

Open ssbarnea opened this issue 8 years ago • 3 comments

Sem-Ver is a way to add meta-data information about commit types that is growing more and more popularity.

A project using adopting Sem-Ver in comments, would be able to:

  • auto-generate next version number
  • auto-generate meaningful changelists

Mainly this is based on the concept that each commit should fix in one of these categories:

I was not able to find an official specification regarding recognized SemVer keywords (symbols) but so far this list seems to be supported by all implementations I found so far:

  • feature (or new feature)
  • api-break -- suggested use of sem-ver: .*break.* regexp
  • deprecation
  • bugfix -- seems to be default

Please note sem-ver seems to allow multiple keywords separated by commands, which means that the verification should not enforce a specify syntax: it should raise an error only if it failed to match any known strings.

Few resources:

  • http://docs.openstack.org/developer/pbr/
  • https://specs.openstack.org/openstack/oslo-specs/specs/juno/pbr-semver.html
  • http://autosemver.readthedocs.io/en/latest/usage.html

ssbarnea avatar Jan 22 '17 16:01 ssbarnea

Hi @ssbarnea.

The existing hook appears to be compatible with all of the examples on http://autosemver.readthedocs.io/en/latest/usage.html

Can you give me an example of a Sem-Ver commit message that is incorrectly reporting warnings?

Tom

tommarshall avatar Jan 24 '17 14:01 tommarshall

Hi @ssbarnea,

Are you able to provide some examples of Sem-Ver commit messages that reporting warnings?

Thanks, Tom

tommarshall avatar Apr 26 '17 14:04 tommarshall