Allow the user to add more sections to the changelog instead of just features and fixes

[silkentrance]

I am currently working on a patch that will allow the user to add custom sections to the changelog, e.g.

Release v0.2.1 (2014-11-10)

API Changes:

 - Tool#extend now expects three parameters instead of just one

API Deprecations:

 - Tool#shutdown is now deprecated, use Tool#quit instead

New Features:

 - ...

Bug Fixes:

 - ...

Miscellaneous:

 - implemented more test cases
 - integrated Travis CI
 - ...

and so on.

I will pour you in a pull request as soon as it is done. Of course I will try to make it backwards compatible so that existing build configurations need not be changed.

[silkentrance]

Here is an excerpt of my current gruntfile changelog configuration (coffee-script)

167         changelog :
168 
169             default :
170 
171                 options :
172 
173                     others : true
174 
175                     dest : 'CHANGELOG'
176 
177                     insertType : 'prepend'
178 
179                     sections :
180 
181                         apichanges : /^\s*- changed (#\d+):?(.*)$/i
182                         deprecations : /^\s*- deprecated (#\d+):?(.*)$/i
183                         features : /^\s*- feature (#\d+):?(.*)$/i
184                         fixes : /^\s*- fixes (#\d+):?(.*)$/i
185                         others : /^\s*- (.*)$/
186 
187                     template : 'Release v<%= pkg.version %> ({{date}})\n\n{{> features }}{{> fixes }}{{> apichanges }}{{> deprecations }}{{> others }}'
188 
189                     partials :
190 
191                         entry : changelogEntryPartial
192                         apichanges : changelogBuildPartial 'apichanges', 'entry', 'API Changes'
193                         deprecations : changelogBuildPartial 'deprecations', 'entry', 'Deprecated'
194                         features : changelogBuildPartial 'features', 'entry', 'New Features'
195                         fixes : changelogBuildPartial 'fixes', 'entry', 'Bug Fixes'
196                         others : changelogBuildPartial 'others', 'entry', 'Miscellaneous'

[silkentrance]

And here is the generated CHANGELOG

https://github.com/vibejs/vibejs-namespaces/blob/master/CHANGELOG

of course I had to tweak it a bit as my commit messages then did not follow the specified rules.

[silkentrance]

@ericmatthys ping - are you still supporting this?

[mischah]

Looks interesting. Guess you are not the only one, who might be interested in that.
Will your changes introduce breaking changes? Or is it backward compatible with existing configs?

[silkentrance]

I am sure that it is backwards compatible, see the configureSections() function which defaults to the original behaviour and will mix in the new options.sections only when available.

[silkentrance]

I will rebase this to a single commit ASAP.

[mischah]

👍

Don’t forget to add test 😊

[silkentrance]

Will do.

[silkentrance]

Closing since I no longer have need for this.