Skip to content

feat(conventional_commits): Add exclamation on commit title for breaking change #1576

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

Open
wants to merge 14 commits into
base: v4-9-0-test
Choose a base branch
from

Conversation

bastien31
Copy link

@bastien31 bastien31 commented Aug 12, 2025

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

  • Add test cases to all the changes you introduce
  • Run poetry all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run poetry doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external) in the documentation

When running poetry doc, any broken internal documentation links will be reported in the console output like this:

INFO    -  Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.

Expected Behavior

Steps to Test This Pull Request

Additional Context

@bastien31 bastien31 changed the title Allow exclamation on breaking change for conventional commit [draft] Allow exclamation on breaking change for conventional commit Aug 12, 2025
@bastien31 bastien31 marked this pull request as draft August 12, 2025 11:13
@bastien31 bastien31 changed the title [draft] Allow exclamation on breaking change for conventional commit Allow exclamation on breaking change for conventional commit Aug 12, 2025
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 <[email protected]>
@bastien31 bastien31 force-pushed the dev/sfusilier/exclamation_bc_cc branch from 79a72cd to dad2e40 Compare August 12, 2025 11:21
Copy link

codecov bot commented Aug 12, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.96%. Comparing base (120d514) to head (a7f9233).
⚠️ Report is 756 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1576      +/-   ##
==========================================
+ Coverage   97.33%   97.96%   +0.63%     
==========================================
  Files          42       58      +16     
  Lines        2104     2709     +605     
==========================================
+ Hits         2048     2654     +606     
+ Misses         56       55       -1     
Flag Coverage Δ
unittests 97.96% <100.00%> (+0.63%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bastien31 bastien31 changed the title Allow exclamation on breaking change for conventional commit Add exclamation on breaking change for conventional commit Aug 12, 2025
@bastien31 bastien31 changed the title Add exclamation on breaking change for conventional commit Add exclamation on commit title for breaking change for conventional commit Aug 12, 2025
@bastien31 bastien31 changed the title Add exclamation on commit title for breaking change for conventional commit feat(conventional_commits): Add exclamation on commit title for breaking change Aug 12, 2025
@bastien31
Copy link
Author

Tested manually:
image
image

Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4...v5)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@bastien31 bastien31 marked this pull request as ready for review August 13, 2025 06:12
@github-actions github-actions bot added the type: feature A new enhacement proposal label Aug 13, 2025
@Lee-W Lee-W changed the base branch from master to v4-9-0-test August 13, 2025 13:34
@Lee-W Lee-W added this to the 4.9.0 milestone Aug 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants