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

Input to BREAKING CHANGE commit requires a body isn't used #779

Open
engnadeau opened this issue Sep 15, 2020 · 2 comments
Open

Input to BREAKING CHANGE commit requires a body isn't used #779

engnadeau opened this issue Sep 15, 2020 · 2 comments
Labels

Comments

@engnadeau
Copy link

engnadeau commented Sep 15, 2020

Actual Behaviour

  • Given the following:
$ git cz --allow-empty
cz-cli@4.1.2, cz-conventional-changelog@3.2.0

? Select the type of change that you're committing: feat:     A new feature
? What is the scope of this change (e.g. component or file name): (press enter to skip) foo
? Write a short, imperative tense description of the change (max 89 chars):
 (25) my very short description
? Provide a longer description of the change: (press enter to skip)
 
? Are there any breaking changes? Yes
? A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself:
 My longer description for a breaking change
? Describe the breaking changes:
 The breaking change itself
? Does this change affect any open issues? No
[master 58da0e1] feat(foo): my very short description
  • Running git log gives:
commit 58da0e199964ec5c50b3521f385deee2d1dfe218
Author: Nicholas Nadeau
Date:   Mon Sep 14 21:42:01 2020 -0400

    feat(foo): my very short description
    
    BREAKING CHANGE: The breaking change itself
  • Notice that the My longer description for a breaking change provided to the prompt is not part of the git log

Expected Behaviour

  • Alternatively, we can remember to provide a longer description from the start:
$ git cz --allow-empty
cz-cli@4.1.2, cz-conventional-changelog@3.2.0

? Select the type of change that you're committing: feat:     A new feature
? What is the scope of this change (e.g. component or file name): (press enter to skip) bar
? Write a short, imperative tense description of the change (max 89 chars):
 (25) another short description
? Provide a longer description of the change: (press enter to skip)
 Now I directly provide a longer description
? Are there any breaking changes? Yes
? Describe the breaking changes:
 Here I describe why I broke things
? Does this change affect any open issues? No
[master fcd9863] feat(bar): another short description
  • git log now shows:
commit fcd986317222ee08076b10650bcbd5ba16cb377f (HEAD -> master)
Author: Nicholas Nadeau
Date:   Mon Sep 14 21:44:04 2020 -0400

    feat(bar): another short description
    
    Now I directly provide a longer description
    
    BREAKING CHANGE: Here I describe why I broke things
@pedroadame
Copy link

+1, the same occurs when commitizen asks for a longer description due to issues closed.

@Phoenix1405
Copy link

Our team just ran into this. Any chance the PR could be merged?

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

No branches or pull requests

4 participants