add breaking-changes section to changelog #530

bastelfreak · 2017-06-24T09:13:37Z

Hi,
this PR allows us to create another section in the changelog, for breaking changes. This is not a 100% implementation of #316, but may help people. Tested this successfully on https://github.com/voxpupuli/puppet-dhcp/blob/master/CHANGELOG.md

olleolleolle · 2017-06-24T09:35:50Z

lib/github_changelog_generator/parser.rb

@@ -129,6 +132,9 @@ def self.setup_parser(options)
        opts.on("--enhancement-labels  x,y,z", Array, 'Issues with the specified labels will be always added to "Implemented enhancements" section. Default is \'enhancement,Enhancement\'') do |list|
          options[:enhancement_labels] = list
        end
+        opts.on("--breacking-labels x,y,z", Array, 'Issues with these lables will be added to a new section, called "Breaking Changes". Default is \'backwards-incompatible\'') do |list|


Typos:

breacking-labels => breaking-labels

lables => labels

olleolleolle

I like this feature.

Q: If a PR is marked as both Breaking and an Enhancement, it would be in both lists, right?

olleolleolle · 2017-06-24T09:39:32Z

Looking at the generated CHANGELOG.md, I feel that it'd be cool to place any breaking changes section FIRST.

olleolleolle · 2017-06-24T10:03:04Z

So, there's room for careful refactoring - or disabling a RuboCop check to pass this:

lib/github_changelog_generator/generator/generator.rb:105:5: C: Metrics/CyclomaticComplexity: Cyclomatic complexity for parse_by_sections is too high. [8/7]
    def parse_by_sections(issues, pull_requests)
    ^^^

bastelfreak · 2017-06-24T10:07:23Z

I tried to refactor it, but didn't find a clean solution. If anybody has ideas please let me know. I will try to place the section at the beginning.

olleolleolle · 2017-06-24T10:10:33Z

@bastelfreak Failing forward is also a good option!

Add a # rubocop:disable Metrics/CyclomaticComplexity as a comment on the line of the def of the offending method; and the crypt keepers will get to this gnarly bit at some point in the future.

Don't worry about it.

bastelfreak · 2017-06-24T11:25:53Z

@olleolleolle I reordered the output, the breaking stuff should now be the first.

bastelfreak · 2017-07-19T21:27:17Z

Hi @olleolleolle, what needs to be done to get this merged?

bastelfreak · 2017-07-19T23:45:16Z

I made some tests again and I'm not 100% if it still works after I changed the ordering. I will have a look tomorrow.

hunner · 2017-08-10T16:56:10Z

Q: If a PR is marked as both Breaking and an Enhancement, it would be in both lists, right?

No, backwards-incompatible (or "breaking") changes are always features because you are enhancing the project with behavior that is desirable, so it would not make sense to put them in both sections.

For a standardized workflow around this, see http://keepachangelog.com/ . It's great, because it tries to make a portable standardized changelog format that works anywhere, and has a formal definition for what goes in each section and how to adhere to http://semver.org/ .

bastelfreak · 2017-09-25T21:25:09Z

Hi @olleolleolle @skywinder could you recheck this PR?
I fixed one issue and rebased against latest master.

bastelfreak · 2017-09-30T19:04:59Z

Hi @olleolleolle, can you check this PR as well? Would be awesome!

olleolleolle · 2017-09-30T19:23:04Z

Style Feedback: Avoid using push, use "the shovel operator" (<<) to append to lists.
Design note: Avoid adding more repetition: Find a way to not add a fourth repeat of things which are already too long
- example: bugs_a, enhancement_a, breaking_a, issues_a = - this calls out for some sort of structure
- example continued: generate_sub_section repeated once per those things, each with a named option
- example continued once more: parse_by_sections also has 4 of this thing

bastelfreak · 2017-09-30T20:10:48Z

replaced push with shovel operator
rebased

ekohl · 2017-10-06T14:11:56Z

lib/github_changelog_generator/generator/generator.rb

    # This method sort issues by types
    # (bugs, features, or just closed issues) by labels
    #
    # @param [Array] issues
    # @param [Array] pull_requests
-    # @return [Array] tuple of filtered arrays: (Bugs, Enhancements Issues)
+    # @return [Array] tuple of filtered arrays: (Bugs, Enhancements, Breaking stuff,  Issues)
    def parse_by_sections(issues, pull_requests)


I'm looking at the code and I'm want some verification: is the goal that an issue is always in 1 section, preferably by a label but otherwise in the container "issues". For Pull requests it should be in 1 section but if it's not, it remains in the pull_requests array (that's modified in place). Correct?

At the moment, the breaking change appears in multiple sections. See https://github.com/voxpupuli/puppet-rabbitmq/blob/33bc9ef7f69155d602f1cdd5abf5a794d1d8a27c/CHANGELOG.md#v700-2017-09-14 for example of where this branch was recently used.
@hunner has suggested this actually might not be the best behaviour. #530 (comment)

ekohl@f5cb492 is my attempt at a cleanup and has tests. I kept current code if multiple labels match but maybe breaking should be at the top.

bastelfreak · 2017-10-10T16:51:48Z

@olleolleolle I added the commit from @ekohl, could you take a look again?

olleolleolle · 2017-10-10T16:57:54Z

@bastelfreak Thanks for that.

Could you fix the lint complaints?

olleolleolle · 2017-10-10T18:13:04Z

@bastelfreak Thanks for passing lint checks, I can merge this from here.

nfischer · 2018-01-18T20:37:57Z

Should this be documented on the README?

bastelfreak force-pushed the breaking branch from bc9caaa to 964efb1 Compare June 24, 2017 09:34

olleolleolle reviewed Jun 24, 2017

View reviewed changes

bastelfreak force-pushed the breaking branch from 964efb1 to 5c07518 Compare June 24, 2017 09:37

olleolleolle added the enhancement label Jun 24, 2017

bastelfreak force-pushed the breaking branch from 5c07518 to 8165141 Compare June 24, 2017 11:25

bastelfreak force-pushed the breaking branch from 8165141 to b6fe0c3 Compare June 24, 2017 13:33

HAIL9000 mentioned this pull request Aug 18, 2017

add breaking-changes section to changelog DavidS/github-changelog-generator#1

Open

bastelfreak force-pushed the breaking branch from f24e605 to 935a1ca Compare September 25, 2017 21:20

bastelfreak force-pushed the breaking branch from 935a1ca to 5bc498e Compare September 30, 2017 20:09

bastelfreak force-pushed the breaking branch from 5bc498e to 9e4d7cd Compare October 3, 2017 21:24

bastelfreak added 2 commits October 6, 2017 15:43

add breaking-changes section to changelog

c05ec19

replace legacy push with shovel operator

b4e7cc7

bastelfreak force-pushed the breaking branch from 9e4d7cd to b4e7cc7 Compare October 6, 2017 13:43

ekohl reviewed Oct 6, 2017

View reviewed changes

Clean up parse_by_sections

eb9e83a

bastelfreak added 2 commits October 10, 2017 19:23

rubocop autofixes

8a7cdaa

reduce complexity in parse_by_sections()

7fc20cd

Merge branch 'master' into breaking

ade3c09

olleolleolle merged commit 21ec2db into github-changelog-generator:master Oct 10, 2017

bastelfreak deleted the breaking branch October 10, 2017 20:24

hunner mentioned this pull request Feb 20, 2018

Fix unlabeled, mixed labels, and unmapped labels handling #618

Merged

hunner mentioned this pull request Apr 12, 2018

Release prep 2.0.0 #641

Closed

skywinder added this to the 2.0.0 milestone Apr 15, 2018

Uh oh!

add breaking-changes section to changelog #530

add breaking-changes section to changelog #530

Uh oh!

Conversation

bastelfreak commented Jun 24, 2017

Uh oh!

olleolleolle Jun 24, 2017

Choose a reason for hiding this comment

Uh oh!

olleolleolle left a comment

Choose a reason for hiding this comment

Uh oh!

olleolleolle commented Jun 24, 2017

Uh oh!

olleolleolle commented Jun 24, 2017

Uh oh!

bastelfreak commented Jun 24, 2017

Uh oh!

olleolleolle commented Jun 24, 2017

Uh oh!

bastelfreak commented Jun 24, 2017

Uh oh!

bastelfreak commented Jul 19, 2017

Uh oh!

bastelfreak commented Jul 19, 2017

Uh oh!

hunner commented Aug 10, 2017

Uh oh!

bastelfreak commented Sep 25, 2017

Uh oh!

bastelfreak commented Sep 30, 2017

Uh oh!

olleolleolle commented Sep 30, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bastelfreak commented Sep 30, 2017

Uh oh!

ekohl Oct 6, 2017

Choose a reason for hiding this comment

Uh oh!

alexjfisher Oct 6, 2017

Choose a reason for hiding this comment

Uh oh!

ekohl Oct 6, 2017

Choose a reason for hiding this comment

Uh oh!

bastelfreak commented Oct 10, 2017

Uh oh!

olleolleolle commented Oct 10, 2017

Uh oh!

olleolleolle commented Oct 10, 2017

Uh oh!

nfischer commented Jan 18, 2018

Uh oh!

Uh oh!

olleolleolle commented Sep 30, 2017 •

edited

Loading