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

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

Open
2 tasks done
scott-ainsworth opened this issue Oct 14, 2024 · 1 comment
Open
2 tasks done

Comments

@scott-ainsworth
Copy link

Prerequisites

  • I have written a descriptive issue title
  • 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

@asbjornu
Copy link
Member

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

#### Conventional commit messages
If you want to use the [Conventional Commits][conventional-commits] standard,
you can leverage this feature as follows:
```yaml
mode: MainLine # Only add this if you want every version to be created automatically on your main branch.
major-version-bump-message: "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\\([\\w\\s-,/\\\\]*\\))?(!:|:.*\\n\\n((.+\\n)+\\n)?BREAKING CHANGE:\\s.+)"
minor-version-bump-message: "^(feat)(\\([\\w\\s-,/\\\\]*\\))?:"
patch-version-bump-message: "^(fix|perf)(\\([\\w\\s-,/\\\\]*\\))?:"
```

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

No branches or pull requests

2 participants