Generate changelogs that show the commits between tags

[eliperelman]

For example, this would change the latest changelog to:

---

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.

Generated by auto-changelog.

v7.3.0 - 2017-10-31

Merged

• Improve error messaging for middleware used with no entry point #386
• Throw more useful errors when missing commands #393

Commits

• Reformat readme headings, favor spectrum over slack (Reformat readme headings, favor spectrum over slack #396) 78fa05c
• add notes about setup scripts (add notes about setup scripts #388) 21c38fb
• Fixes to publishing 6ea0728

v7.2.3 - 2017-10-26

Merged

• Follow-ups to the switch to Lerna #372

Commits

• Allow using Jest and Mocha presets without Babel (Allow using Jest and Mocha presets without Babel #379) ee2e7ba
• Output logging messages when using watch instead of devServer (Output logging messages when using watch instead of devServer #378) dbc12fd
• Dev: fixing typo in yarn lint script 913a875

v7.2.2 - 2017-10-24

Commits

• Release v7.2.2 d399824
• Use source directory for jest code coverage (Use source directory for jest code coverage #369) 1f09c91
• Remove oao, swap for lerna ee6d47d

v7.2.1 - 2017-10-20

Commits

• Adding docs for hot middleware updates 1318ab5
• feat(hot): Include NamedModulesPlugin for better developer experience (feat(hot): Include NamedModulesPlugin for better developer experience #365) ac62509
• fix: Use cheap-module-eval-source-map for faster recompilation (fix: Use cheap-module-eval-source-map for faster recompilation #366) 66b5594

v7.1.10 - 2017-10-18

Commits

• Release v7.1.10 190de2d
• Update to the newest version of html-webpack-template (Update to the newest version of html-webpack-template #361) 238959c

v7.1.3 - 2017-10-17

Commits

• Release v7.1.3 e909de6
• Add eslintrc.js to .npmignore (Add eslintrc.js to .npmignore #359) 943de06

v7.1.2 - 2017-10-13

Merged

• Upgrade oao/yarn and use --frozen-lockfile with oao bootstrap #354

Commits

• Release 7.1.2 09b8e92
• Remove extra keys that are invalid in eslintrc (Remove extra keys that are invalid in eslintrc #358) 62945b6
• Use latest version of yarn on Travis (Use latest version of yarn on Travis #355) 3d495a8

v7.1.1 - 2017-10-10

Commits

• Release v7.1.1 ed6be9b
• Hotfix - bump webpack-chain to guard non-defined chainedmap entries 2ee3b42

v7.1.0 - 2017-10-06

Commits

• Release 7.1.0 ea0a2ce
• Feature: upgrade webpack-chain to use .before() and .after() (Feature: upgrade webpack-chain to use .before() and .after() #346) 3aa2666
• Preserve ESLint default include when just exclude set (Preserve ESLint default include when just exclude set #344) bb190c4

v7.0.2 - 2017-10-03

Merged

• Remove unused dependencies #339
• Misc documentation fixes - part 2 #335

Fixed

• Simplify require_test.js, making it pass on Windows (Simplify require_test.js, making it pass on Windows #337) #336

Commits

• Release 7.0.2 7e7ecfc
• Configuration docs nits 1a707f6
• Fix link to babel-minify-webpack-plugin options (Fix link to babel-minify-webpack-plugin options #340) 703da77

v7.0.1 - 2017-09-28

Commits

• Release v7.0.1 b138b3d

v7.0.0 - 2017-09-28

Merged

• Upgrading Webpack to v3, merge config as middleware #315

Commits

• Release v7.0.0 a7f701d

v6.2.1 - 2017-09-28

Merged

• Misc documentation fixes #325

Fixed

• Make the lint command check .jsx files too (Make the lint command check .jsx files too #333) #332

Commits

• Release v6.2.1 dd7c5b3
• Small API docs change to avoid confusion. (Small API docs change to avoid confusion. #317) e994c2d

v6.2.0 - 2017-09-12

Merged

• feat: Allow passing any Jest CLI options to neutrino-jest test task #313

Commits

• Release v6.2.0 8237cda
• chore: Add lint-staged and husky (chore: Add lint-staged and husky #314) d854f94

v6.1.8 - 2017-09-07

Fixed

• Fixes devServer with open=true hangs on "Building project" #311 (Fixes #311 #312) #311

Commits

• Release 6.1.8 01d9ae9

v6.1.6 - 2017-08-31

Commits

• Handle list of errors from test command (Handle list of errors from test command #310) 6ceef02
• Release 6.1.6 fff6cbb

v6.1.5 - 2017-08-01

Merged

• Fix hot reload #304

Commits

• Release 6.1.5 f7977ed
• Fixing broken middleware links 21bd4de
• Make it more clear what the env plugin can be used for (Make it more clear what the env plugin can be used for #295) 127aadd

v6.1.4 - 2017-06-29

Commits

• Release v6.1.4 7411f0b
• Correctly override path options for custom options (Correctly override path options for custom options #293) 9cf8080

v6.1.2 - 2017-06-29

Commits

• Release v6.1.2 fc85787
• Add an .npmignore to all packages (Add an .npmignore to all packages #291) ac0fd0d
• Prevent null chunks from preventing naming (Prevent null chunks from preventing naming #284) 03dbed0

v6.1.0 - 2017-06-23

Merged

• Karma coverage #282

Commits

• Release v6.1.0 1de650c
• Add `babel-plugin-istanbul` to ensure accurate coverage is reported. (Add babel-plugin-istanbul to ensure accurate coverage is reported. #279) 4846888
• Ensure test cases are not run 2x in watch mode. (Ensure test cases are not run 2x in watch mode. #280) 5754b99

v6.0.5 - 2017-06-22

Commits

• Release v6.0.5 09b5957
• Hashing entire un-named chunk instead of individual modules (Hashing entire un-named chunk instead of individual modules #278) ec7cf98

v6.0.4 - 2017-06-22

Commits

• Release v6.0.4 7128bb3
• Adding ESLint support back to React (Adding ESLint support back to React #275) f3a61ba
• Add Travis badge to README (Add Travis badge to README #270) 7825767

v6.0.3 - 2017-06-19

Commits

• Release v6.0.3 39f2f32
• Reject test runners when non-zero exit code (Reject test runners when non-zero exit code #269) 1435477
• Correct typo (Correct typo #266) d957604

v6.0.2 - 2017-06-16

Commits

• Updating oao, yarn.lock files, travis installation 82a24dd
• Releasing v6.0.2 0370c89
• Fixing issues in babel merging and dynamic named chunks (Fixing issues in babel merging and dynamic named chunks #264) b02679f

v6.0.0 - 2017-06-15

Merged

• v6 #254
• Document conditional configuration #250
• Hotfix/neutrino preset jest/relative alias handling #243
• Add description how to ignore files in an IDE lint #205

Commits

• Releasing v6.0.0 8b07eed
• Yarn lockfile updates 3a3f73e
• Changelog 8aa0b45

v5.9.0 - 2017-05-26

Merged

• add option for node debugging #215

Commits

• Releasing v5.9.0 c3d7020
• Docs for --debug dde1f40
• README update a446881

v5.8.0 - 2017-05-02

Merged

• Feature/universal entry #195

Commits

• Releasing v5.8.0 2afdd26
• Indent to clarify context change (Indent to clarify context change #191) d7688dc

v5.7.0 - 2017-04-25

Merged

• Simplify error logging. #148

Commits

• Release v5.7.0 9186de6
• Fixing typo in karma docs b3d3c73
• Fix typo in preset name (Fix typo in preset name #190) 4a3842f

v5.6.9 - 2017-04-18

Merged

• Consider case when 'core-js' is located in 'babel-polyfill' root #181

Commits

• Release v5.6.0 3f56635
• Merge branch 'master' of github.com:mozilla-neutrino/neutrino-dev 587851b
• Setting devServer publicPath to / (Setting devServer publicPath to / #179) fbe39af

v5.5.1 - 2017-04-12

Merged

• Polyfills #173

Commits

• v5.5.0 -> v5.5.1 425f3ac
• Adding getters and setters for path options, options for middleware (Adding getters and setters for path options, options for middleware #176) 957645f
• Set devServer.publicPath to use output.publicPath (Set devServer.publicPath to use output.publicPath #177) ebc078a

v5.4.0 - 2017-04-07

Merged

• neutrino-middleware-image-loader: Use svg-url-loader for svg rule #171

Commits

• Releasing v5.4.0 f2c1dfb
• Fixing incorrect documentation for linting (Fixing incorrect documentation for linting #169) 5724b5a
• Update changelog 20c1065

v5.3.0 - 2017-04-03

Commits

• Release v5.3.0 aec1cbb
• Update build executable to respect config stats. (Update build executable to respect config stats. #163) ab38cd5
• fix eslint-semi-off middleware example (fix eslint-semi-off middleware example #161) e6924e2

v5.2.0 - 2017-04-01

Commits

• Allow setting karma middleware options as overridable (Allow setting karma middleware options as overridable #160) 3f90dfd
• neutrino v5.1.1 878026a
• options.output mis-named as options.build (options.output mis-named as options.build #159) e9a7a36

v5.1.0 - 2017-03-30

Commits

• Upgrading webpack-chain to v3.1 (Upgrading webpack-chain to v3.1 #157) d009882
• Releasing v5.1.0 adcc04f
• Adding code coverage with Codacy support (Adding code coverage with Codacy support #156) 9871634

v5.0.2 - 2017-03-28

Merged

• Adding documention about web publicPath #141
• Hopefully last round of docs changes for v5 #140
• Upgrading dependencies #139
• Validate webpack configuration before running compiler #138
• Functional refactor #137
• Resolve packages from parent node_modules folders #135
• Fix typo in develop function. #132
• Neutrino webpack #127
• Rename `getWebpackOptions` to `getWebpackConfig`. #123
• Neutrino refactor #119
• Fixing linting to run for all packages #120
• Fix link #117
• Fix svg mime-type #115
• Adding option-configurable compile targets #111
• Add support building react-native app #88
• Defer test configuration overrides until on:test #110
• Using neutrino to lint itself #106
• Should generate correct sourcemaps during dev #105
• eslint #102
• README updates for v5 #103
• v5 Docs #98
• Baseline for Neutrino v5 #86
• Added coverage support to jest preset #76
• Add Community section for starter kits #78
• Add FAQ section #62

Commits

• Refining middleware concept, splitting presets into middleware packages f202977
• Updating yarn.lock files 4b8eb84
• Upgrading to webpack-chain v3, add more tests for full presets 49b9e29

v4.2.0 - 2017-02-24

Merged

• v4.2 #54
• add eslint-jest-plugin #48
• Add github repo link to gitbook #53
• Add website to GitHub homepage. Fixes Add description and website to github homepage #49 #51

Fixed

• Add website to GitHub homepage. Fixes Add description and website to github homepage #49 #49

Commits

• Throw exception on missing module (Throw exception on missing module #45) c1033ae
• Fix typo in usage example (Fix typo in usage example #52) dac5df7

v4.1.1 - 2017-02-22

Commits

• Wrong lint base version fe5c381

v4.1.0 - 2017-02-22

Commits

• Introduce lint base to make lint preset creation much easier (Introduce lint base to make lint preset creation much easier #41) b838a0d
• Changelogs (Changelogs #31) b32ad66
• Docs: learning resources 2647be7

v4.0.1 - 2017-02-17

Merged

• Fix: React lifecycle methods shouldn't fail eslint #26
• Slack badges #25
• Badge updates #24

Commits

• Tagline update 24900a4

v4.0.0 - 2017-02-16

Commits

• ._. 02a3983
• Major version ec22aca

v4.0.0-beta.3 - 2017-02-16

Commits

• All bump 065cda7
• Bump cde3503
• README typo a6ad540

v4.0.0-beta.0 - 2017-02-16

Merged

• Documentation #17
• Removing base preset, adding Airbnb preset #22
• Simplify configuration #18
• Displaying fancier build status during dev server #16
• Fixes HMR #15
• Pluggable event architecture mode, new test presets #10
• add version badges #12
• HTML update #2
• Linting changes and new config API #1
• Migration to webpack 2 #10
• Init in cli #8

Commits

• Attempting to force v4 35408a8
• oao upgrade 4925b1d
• Release commands a792904

[edmorley]

Love this! The existing changelog using dates didn't feel right, and I'd been meaning to suggest doing something like this.

At the moment, since Neutrino isn't using the "fixes" notation recognised by auto-changelog, everything has been split out into "merged" and "commits", which seems a bit arbitrary. Looking at the available templates, I see the now default template (compact) avoids this distinction, and might result in a cleaner changelog? See:
https://github.com/CookPete/auto-changelog/tree/master/templates

[eliperelman]

@edmorley definitely! Also don't like the 3 commit limit

cookpete/auto-changelog#11

[edmorley]

Also don't like the 3 commit limit

Yeah me neither - seems a bit arbitrary.

[eliperelman]

Alrighty, I have the updated version of auto-changelog here, along with an updated changelog.

[edmorley]

What do you think about:

Looking at the available templates, I see the now default template (compact) avoids this distinction, and might result in a cleaner changelog?

:-)

[eliperelman]

Sorry, I tried to imply my agreement with:

@edmorley definitely

fail

Anyway, the script now doesn't specify the template, so it uses the default one now. 😃

[edmorley]

Ah my bad I was looking at the PR description as the preview, but I see the CHANGELOG.md in the PR itself now shows the new output, and looks great :-)

[eliperelman]

🎉

[eliperelman]

That looks way better: https://github.com/mozilla-neutrino/neutrino-dev/blob/master/CHANGELOG.md

[cookpete]

Also don't like the 3 commit limit

Yeah me neither - seems a bit arbitrary.

The commit limit was there to prevent changelogs just becoming a massive commit log diff but the new commit-limit flag means devs can do whatever they want (thanks again @eliperelman). 3 just seemed like a nice number for creating changelogs that weren't too verbose or sparse.

This is by far the most popular repo using auto-changelog so I'm happy to work on making it more flexible if there are other things you guys think would improve it. I've noticed that it isn't parsing some of your merge commits correctly, for example, so I'll take a look at that.

At the moment, since Neutrino isn't using the "fixes" notation recognised by auto-changelog, everything has been split out into "merged" and "commits", which seems a bit arbitrary.

auto-changelog just uses the notation that GitHub uses.