Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ssbarnea opened this issue Jan 22, 2017 · 2 comments
Open

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

ssbarnea opened this issue Jan 22, 2017 · 2 comments

Comments

@ssbarnea
Copy link

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:

@tommarshall
Copy link
Owner

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
Copy link
Owner

Hi @ssbarnea,

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

Thanks,
Tom

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants