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.

Sign up for GitHub

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

Jump to bottom

CT1: contrib-title-conventional-commits do not support the BREAKING CHANGE symbol "!" #186

Closed
linjiX opened this issue Apr 3, 2021 · 1 comment · Fixed by #190
Closed

CT1: contrib-title-conventional-commits do not support the BREAKING CHANGE symbol "!" #186

linjiX opened this issue Apr 3, 2021 · 1 comment · Fixed by #190
Labels
enhancement User-facing feature enhancements
Milestone
0.16.0

Comments

@linjiX
Copy link

linjiX commented Apr 3, 2021 •
edited
Loading

According to the Conventional Commits

BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.

If included in the type/scope prefix, breaking changes MUST be indicated by a ! immediately before the :. If ! is used, BREAKING CHANGE: MAY be omitted from the footer section, and the commit description SHALL be used to describe the breaking change.

But gitlint reports error if adding ! after the scope:

$ echo 'test(scope)!: title' | gitlint --contrib=CT1 -c general.ignore=body-is-missing
1: CT1 Title does not follow ConventionalCommits.org format 'type(optional-scope): description': "test(scope)!: title"
@linjiX linjiX changed the title Contrib rule CT1: contrib-title-conventional-commits do not support the BREAKING CHANGE symbol "!" CT1: contrib-title-conventional-commits do not support the BREAKING CHANGE symbol "!" Apr 3, 2021
@rafaelbubach
Copy link
Contributor

This should solve the problem.
#190

@rafaelbubach rafaelbubach mentioned this issue May 13, 2021
Merged
@jorisroovers jorisroovers added this to the 0.15.2 milestone Sep 19, 2021
@jorisroovers jorisroovers added the enhancement User-facing feature enhancements label Sep 19, 2021
@jorisroovers jorisroovers modified the milestones: 0.15.2, 0.16.0 Sep 27, 2021
jorisroovers added a commit that referenced this issue Oct 8, 2021
@jorisroovers
0.16.0 release
0be7cbe 
- Python 3.10 support
- New Rule: ignore-by-author-name allows users to skip linting commit messages
  made by specific authors
- --commit <SHA> flag to more easily lint a single commit message (#141)
- --fail-without-commits flag will force gitlint to fail (exit code 253) when
  the target commit range is empty (typically when using --commits) (#193)
- Bugfixes:
  - contrib-title-conventional-commits (CT1) now properly enforces the commit
    type (#185)
  - contrib-title-conventional-commits (CT1) now supports the BREAKING CHANGE
    symbol "!" (#186)
- Under-the-hood: dependencies updated, test and github action improvements.

Full Release details in CHANGELOG.md.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement User-facing feature enhancements
Projects
None yet
Milestone
0.16.0
Development

Successfully merging a pull request may close this issue.

Allow "!" for breaking change commits rafaelbubach/gitlint
3 participants
@jorisroovers @rafaelbubach @linjiX