Merge pull request mozilla#349 from kumar303/changelog-cli

chore: switch to conventional-changelog

Author: kumar303

CONTRIBUTING.md

@@ -103,15 +103,15 @@ it is okay to include each as a separate commit.
 To release a new version of `web-ext`, follow these steps:
 
 * Pull from master to make sure you're up to date.
+* Create a changelog by running `grunt changelog`.
+  This will output a Markdown list of all unreleased changes.
+  You can copy/paste this into the tag notes on github after the tag is created.
+  It may require some manual editing. For example, commit messages might be
+  truncated.
 * Bump the version in `package.json`.
 * Commit and push the version change.
 * Tag master with the new release you're about to create
   (example: `git tag 1.0.1`) and run `git push --tags upstream`.
-* Create a changelog by running `grunt changelog:1.0.0` where
-  `1.0.0` is the *last published* release tag. This will output a Markdown list
-  of changes that you can paste into the tag notes on github. It may
-  require some editing. For example, the *Uncategorized* section may need
-  rearranging.
 * Go to the github
   [releases page](https://github.com/mozilla/web-ext/releases),
   edit the tag you just created, and enter in the changelog notes.

Gruntfile.js

@@ -62,19 +62,8 @@ module.exports = function(grunt) {
     'lint-commit-msg', 'checks for commit message lint', function() {
       var done = this.async();
       if (semver.satisfies(process.version, '>= 4.0.0')) {
-
-        var proc = spawn('conventional-changelog-lint', ['--from', 'master']);
-        proc.stderr.on('data', function(data) {
-          grunt.log.write(data);
-        });
-        proc.stdout.on('data', function(data) {
-          grunt.log.write(data);
-        });
-        proc.on('close', function(code) {
-          var succeeded = code === 0;
-          done(succeeded);
-        });
-
+        gruntExec(grunt, 'conventional-changelog-lint', ['--from', 'master'],
+                  done);
       } else {
         grunt.log.writeln(
           'task skipped because this version of Node is too old');
@@ -103,107 +92,32 @@ module.exports = function(grunt) {
     });
 
   grunt.registerTask(
-    'changelog', 'Create a changelog from commits', function(tag) {
+    'changelog', 'Create a changelog from commits', function() {
       // See https://github.com/mozilla/web-ext/blob/master/CONTRIBUTING.md#writing-commit-messages
-      var done = this.async();
-      var results = {};
-
-      if (tag === undefined) {
-        grunt.log.writeln(
-          'Missing first agument: the current git release tag ' +
-          '(before the next release)');
-        return done(false);
-      }
-
-      function processLine(line) {
-        // First, get the commit hash.
-        var metaMatch = /commit:\{([^\}]+)\} (.*)/.exec(line);
-        if (!metaMatch) {
-          throw new Error('Could not find commit hash in ' + line);
-        }
-        var commitHash = metaMatch[1];
-        line = metaMatch[2]; // strip off the commit hash part.
-
-        // Parse the semantic commit message.
-        // e.g. fix(): Fixed some stuff
-        var match = /^([a-zA-Z0-9]+)\(?.*\)?: (.*)$/g.exec(line);
-        var bucket;
-        var message = line;
-        if (!match) {
-          bucket = results.uncategorized = results.uncategorized || [];
-        } else {
-          var type = match[1].toLowerCase();
-          bucket = results[type] = results[type] || [];
-          message = match[2];
-        }
-
-        bucket.push({msg: message, commit: commitHash});
-      }
-
-      function commitLink(commit) {
-        // Create a Markdown link to the commit.
-        return '[' + commit + ']' +
-          '(https://github.com/mozilla/web-ext/commit/' + commit + ')';
-      }
-
-      function bullet(text) {
-        // Create a Markdown bullet point.
-        return '  * ' + text;
-      }
-
-      function writeChangelog() {
-        [
-          ['New features:', 'feat'],
-          ['Fixes:', 'fix'],
-          ['Performance enhancements:', 'perf'],
-          ['Uncategorized:', 'uncategorized'],
-        ].forEach(function(conf) {
-          var header = conf[0];
-          var key = conf[1];
-
-          if ((results[key] || []).length) {
-            grunt.log.writeln(header);
-            results[key].forEach(function(data) {
-              grunt.log.writeln(
-                bullet(data.msg + ' (' + commitLink(data.commit) + ')'));
-            });
-            grunt.log.writeln('');
-          }
-        });
-        grunt.log.writeln('General maintenance:');
-        grunt.log.writeln(bullet(
-          results.chore.length + ' dependency updates (or other chores)'));
-        grunt.log.writeln(bullet(
-          results.docs.length + ' documentation updates'));
-      }
+      gruntExec(grunt, 'conventional-changelog', ['-p', 'angular', '-u'],
+                this.async());
+    });
 
-      var git = spawn(
-        'git',
-        ['log', '--no-merges', '--format=commit:{%h} %s', tag + '...master']);
+};
 
-      git.stderr.on('data', function(data) {
-        grunt.log.writeln(data);
-        done(false);
-      });
 
-      git.stdout.on('data', function(data) {
-        data.toString().split('\n').forEach(function(line) {
-          if (line !== '') {
-            processLine(line);
-          }
-        });
-      });
+function gruntExec(grunt, cmd, args, onCompletion) {
+  var PATH = process.env.PATH || '';
+  // Make sure the script dir for local node modules is on the path.
+  process.env.PATH =
+    PATH + ':' + path.resolve(__dirname) + '/node_modules/.bin';
+  var proc = spawn(cmd, args);
 
-      git.on('close', function(code) {
-        if (code !== 0) {
-          grunt.log.writeln('git exited: ' + code);
-          done(false);
-        } else {
-          writeChangelog();
-          done(true);
-        }
-      });
+  proc.stderr.on('data', function(data) {
+    grunt.log.write(data);
+  });
 
-    });
+  proc.stdout.on('data', function(data) {
+    grunt.log.write(data);
+  });
 
-};
+  proc.on('close', function(code) {
+    var succeeded = code === 0;
+    onCompletion(succeeded);
+  });
+}

package.json

@@ -71,6 +71,7 @@
     "babel-preset-es2015": "6.9.0",
     "babel-preset-stage-2": "6.11.0",
     "chai": "3.5.0",
+    "conventional-changelog-cli": "1.2.0",
     "conventional-changelog-lint": "1.0.0",
     "copy-dir": "0.3.0",
     "coveralls": "2.11.9",