GitVersion icon indicating copy to clipboard operation
GitVersion copied to clipboard

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

Open scott-ainsworth opened this issue 1 year ago • 1 comments

Prerequisites

  • [x] I have written a descriptive issue title
  • [x] I have searched issues to ensure it has not already been reported

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

scott-ainsworth avatar Oct 14 '24 18:10 scott-ainsworth

@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

asbjornu avatar Oct 15 '24 08:10 asbjornu

This issue has been automatically marked as stale because it has not had recent activity. After 30 days from now, it will be closed if no further activity occurs.

github-actions[bot] avatar Jan 13 '25 11:01 github-actions[bot]

This issue was closed because it has been stalled for 30 days with no activity. Thank you for your contributions

github-actions[bot] avatar Feb 13 '25 11:02 github-actions[bot]