feat(conventional_commits): Add exclamation on commit title for breaking change #1576
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bastien31
changed the title
bastien31
changed the title
bastien31
force-pushed
the
dev/sfusilier/exclamation_bc_cc
branch
from
79a72cd to
dad2e40
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1576 +/- ##
==========================================
+ Coverage 97.33% 98.25% +0.91%
==========================================
Files 42 58 +16
Lines 2104 2698 +594
==========================================
+ Hits 2048 2651 +603
+ Misses 56 47 -9
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bastien31
changed the title
bastien31
changed the title
bastien31
changed the title
|
Tested manually: |
bastien31
force-pushed
the
dev/sfusilier/exclamation_bc_cc
branch
2 times, most recently
from
cf7c06d to
f69f73f
Compare
bastien31
force-pushed
the
dev/sfusilier/exclamation_bc_cc
branch
from
f69f73f to
186fbd8
Compare
|
After a rebase on master, I had to add following fix 186fbd83fc7d2fa8c363fa2a08a7d901a657517c to get tests passed. |
|
yep, this needs #1591 to be merged |
Comment on lines
157
to
160
| # Check if breaking change exclamation in title is enabled | ||
| breaking_change_exclamation_in_title = self.config.settings.get( | ||
| "breaking_change_exclamation_in_title", False | ||
| ) |
There was a problem hiding this comment.
How about
title = f"{prefix}{scope}"
if is_breaking_change and self.config.settings.get("breaking_change_exclamation_in_title"):
title += "!"There was a problem hiding this comment.
Ok for the simplification, I would suggest something a little bit different to keep footer handling.
Add a configuration (disable by default) to allow exclamation in commit title to ease identify BC simple git log parsing. Signed-off-by: Sebastien Fusilier <sebastien.fusilier@gmail.com>
Force consistent terminal width for tests to avoid wrapping differences between single and multi-worker pytest modes Signed-off-by: Sebastien Fusilier <sebastien.fusilier@gmail.com>
bastien31
force-pushed
the
dev/sfusilier/exclamation_bc_cc
branch
from
186fbd8 to
2dac9eb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a configuration (disable by default) to allow exclamation in commit title to ease identify BC simple git log parsing.
Description
Conventional commit allow to put breaking change exclamation character in git commit title.
This is a useful convention to identify BC commit from the title only.
As it is supported in commitizen parsing, add the option to generate it.
Checklist
Code Changes
poetry alllocally to ensure this change passes linter check and testsDocumentation Changes
poetry doclocally to ensure the documentation pages renders correctlyExpected Behavior
Steps to Test This Pull Request
Additional Context