Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

chore(CHANGELOG): add an extra new line after each item in the "Breaking Changes" list #9550

Closed

Conversation

gkalpak
Copy link
Member

@gkalpak gkalpak commented Oct 10, 2014

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**: due to ...
  ...
- **item 2**: due to ...
  ...

For example, this was the case with the 1.3.0-rc.5 CHANGELOG (see the last ngAnimate breaking change).

…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 ...
      ...
@gkalpak
Copy link
Member Author

gkalpak commented Oct 10, 2014

BTW, if one puts the Closes/Fixes #XYZ lines after the BREAKING CHANGE notice, then those lines appear in the CHANGELOG (under "Breaking Changes"):

Breaking Changes

This and that breaks.

Closes #1234 Closes #5678

Do you think it would be better if:

  1. either those Closes/Fixes lines where removed from the "Breaking Changes" section (since they are already mentioned above) or

  2. they should be formatted as links (and each on a new line):

    Closes Made the route matcher public, allows to parse inputs from the url #1234
    Closes docs(document): so it looks better #5678

@gkalpak gkalpak changed the title chore(CHANGELOG): add an extra new line after each item in the "BREAKING CHANGES" list chore(CHANGELOG): add an extra new line after each item in the "Breaking Changes" list Oct 10, 2014
@petebacondarwin
Copy link
Contributor

@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

@petebacondarwin
Copy link
Contributor

Actually perhaps we should just be using https://github.com/ajoslin/conventional-changelog instead and provide any bug fixes to that?

@petebacondarwin
Copy link
Contributor

I'm going to merge this as-is anyway since it is helpful.

@petebacondarwin
Copy link
Contributor

Landed as 4474633

@rafinskipg
Copy link

You can use this grunt plugin that actually uses your changelog. https://github.com/rafinskipg/git-changelog

@rafinskipg
Copy link

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

@gkalpak gkalpak deleted the changelog-create-links-to-issues branch October 13, 2014 09:59
gkalpak added a commit to gkalpak/angular.js that referenced this pull request Dec 7, 2014
gkalpak added a commit to gkalpak/angular.js that referenced this pull request Dec 8, 2014
gkalpak added a commit that referenced this pull request Dec 8, 2014
Adds tests for the functionality added by #9550.

Closes #10358
gkalpak added a commit that referenced this pull request Dec 8, 2014
Adds tests for the functionality added by #9550.

Closes #10358
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants