GitTools / GitVersion

From git log to SemVer in no time
https://gitversion.net/docs/
MIT License
2.87k stars 654 forks source link

[ISSUE]: "CONVENTIONAL COMMITS" should allow hyphen and space #4258

Open scott-ainsworth opened 1 month ago

scott-ainsworth commented 1 month ago

Prerequisites

GitVersion package

GitVersion.Tool

GitVersion version

6.0.2

Operating system

N/A

What are you seeing?

According to the Conventional Commits Specification requirement 16: “BREAKING-CHANGE MUST be synonymous with BREAKING CHANGE, when used as a token in a footer.” However, the current documentation includes on “BREAKING CHANGE” with only a space.

What is expected?

Changing the regex from “…BREAKING CHANGE…” to “…BREAKING[ -]CHANGE…”.

Steps to Reproduce

Review the Conventional Commits major-version-bump-message regular expression in the Version Incrementing documentation. Observe that the regular expression includes “BREAKING CHANGE” with a space an no hyphen.

RepositoryFixture Test

No response

Output log or link to your CI build (if appropriate).

No response

asbjornu commented 1 month ago

@scott-ainsworth, if you'd like to edit the documentation and submit a pull request, here's the section you're referring to:

https://github.com/GitTools/GitVersion/blob/2cb399b46c1bf83d7b1c68a12a1285f462c4f806/docs/input/docs/reference/version-increments.md?plain=1#L91-L101