-
Notifications
You must be signed in to change notification settings - Fork 27.4k
chore(CHANGELOG): add an extra new line after each item in the "Breaking Changes" list #9550
Conversation
…ING CHANGES" list This ensures that the next item will appear on a new line and be properly parsed as new list item (and not as the continuation of the current item), even if the current item does not end with a newline character. Currently, it would result is something like this: - **item 1**: due to ... blah1 blah1 blah1- **item 2**: due to... blah2 blah2 blah2 instead of the intended: - **item 1**: duo to ... ... - **item 2**: due to ... ...
BTW, if one puts the Breaking Changes
This and that breaks. Do you think it would be better if:
|
@gkalpak - this would benefit from a unit test in https://github.com/angular/angular.js/blob/master/changelog.spec.js Regarding the Closes items - I think they should be stripped from the breaking changes section |
Actually perhaps we should just be using https://github.com/ajoslin/conventional-changelog instead and provide any bug fixes to that? |
I'm going to merge this as-is anyway since it is helpful. |
Landed as 4474633 |
You can use this grunt plugin that actually uses your changelog. https://github.com/rafinskipg/git-changelog |
I'm improving it, you can give ideas for the default options, so it would be more configurable than the actual changelog rafinskipg/git-changelog#11 |
Adds tests for the functionality added by angular#9550.
Adds tests for the functionality added by angular#9550.
This ensures that the next item will appear on a new line and be properly
parsed as new list item (and not as the continuation of the current item),
even if the current item does not end with a newline character.
Currently, it would result is something like this:
instead of the intended:
For example, this was the case with the 1.3.0-rc.5 CHANGELOG (see the last
ngAnimate
breaking change).