Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

feat(changelog): add support for multiline BREAKING paragraph #348

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

Merged
woile merged 1 commit into master from feat/multiline-body
Feb 21, 2021

Conversation

Copy link
Member

@woile woile commented Feb 19, 2021 •
edited
Loading

Description

Checklist

  • Add test cases to all the changes you introduce
  • Run ./script/format and ./script/test locally to ensure this change passes linter check and test
  • Test the changes on the local machine manually
  • Update the documentation for the changes

Expected behavior

Support for multiline body, suppose a commit message like this:

fix: user issue
BREAKING CHANGE: this should be all picked up by commitizen itself, when
I do a new line like this, it will be included in the end result changelog
not this

Commitizen will detect a fix and a BREAKING CHANGE
both will be added to the changelog

Steps to Test This Pull Request

  1. Create a commit like the example above
  2. Run cz changelog
  3. Observe cat CHANGELOG.md

Additional context

Closes #346

@woile woile requested a review from Lee-W February 19, 2021 11:21
Copy link

codecov bot commented Feb 19, 2021 •
edited
Loading

Codecov Report

Merging #348 (0621bc4) into master (1605d69) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph 

@@ Coverage Diff @@
## master #348 +/- ##
=======================================
 Coverage 97.29% 97.29% 
=======================================
 Files 35 35 
 Lines 999 999 
=======================================
 Hits 972 972 
 Misses 27 27
Flag Coverage Δ
unittests 97.29% <ø> (ø)

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

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2387ea7...0621bc4. Read the comment docs.

Copy link
Member Author

woile commented Feb 19, 2021

I'm aware I'm introducing a side-effect which I think is cool.

Given this commit message:

fix: user module now work
fix: another fix
BREAKING CHANGE: You have to fix `here` and `there`
footer

Would output this CHANGELOG:

### Fix
- user module now work
- another fix
### BREAKING CHANGE
- You have to fix `here` and `there`

Copy link
Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor suggestion. Other than that everything looks good to me 🙂

@woile woile merged commit 67c599e into master Feb 21, 2021
@woile woile deleted the feat/multiline-body branch February 21, 2021 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Lee-W Lee-W Lee-W approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Breaking change should support multiline
2 participants

AltStyle によって変換されたページ (->オリジナル) /