RCF-9 Added issue links to release notes

  Implemented by adding a script for post-processing

Author: ScottKelly

.gitignore

@@ -1 +1,2 @@
 node_modules
+.idea

cli.js

@@ -22,7 +22,8 @@ var argv = require("optimist").usage("git-release-notes [<options>] <since>..<un
 	"default": "master"
 })
 .options("s", {
-	"alias": "script"
+	"alias": "script",
+	"default": "./issue-linker.js"
 })
 .options("o", {
 	"alias": "gitlog-option",
@@ -43,15 +44,27 @@ var argv = require("optimist").usage("git-release-notes [<options>] <since>..<un
 })
 .boolean("version")
 .check(function (argv) {
-	if (argv._.length == 2) {
+	// Added template default so only one argument is required
+	if (argv._.length >= 1 && argv._.length <=2) {
 		return true;
 	}
 	throw "Invalid parameters, please specify an interval and the template";
 })
 .argv;
 
 const index = require('./index');
-index(argv, argv._[0], argv._[1])
+
+// default to using the issuelink template to reduce things
+// dev needs to remember
+let template;
+if(!argv._[1]) {
+	template = "issuelink-markdown"
+}
+else {
+	template = argv._[1]
+}
+
+index(argv, argv._[0], template)
 .then(function (output) {
   process.stdout.write(output + "\n");
 })

lib/issue-linker.js

@@ -0,0 +1,29 @@
+/**
+ * Jira used the syntax `<project>-<issue_id>` to link PRs to the original task e.g. VP-986
+ * Based upon ../samples/post-processing.js
+ */
+
+const TITLE_REGEX = /^([A-Z]+-\d+) (.*)$/;
+const ISSUE_TRACKER_HOST = "https://virdocs.atlassian.net/browse/";
+
+module.exports = function (data, callback) {
+  const rewritten = data.commits.map((commit) => {
+    const matches = commit.title.match(TITLE_REGEX);
+    if (matches && matches.length > 2) {
+      // extra metadata to remember the linked tasks
+			commit.issue = matches[1];
+      commit.issueLink = ISSUE_TRACKER_HOST + commit.issue;
+
+      // remove issue from the title
+      commit.title = matches[2];
+    }
+
+    return commit;
+  });
+
+  callback({
+    commits: rewritten.filter(Boolean),
+    // rewrite the range because the template only cares about the newest tag
+    range: data.range.split('..')[1],
+  });
+};

lib/process.js

@@ -15,6 +15,11 @@ exports.processCommits = function processCommits(options, commits, range) {
     debug("Rendering template without post processing");
     return Promise.resolve({ commits: commits });
   }
+  else if (!fs.existsSync(externalScriptPath)) {
+		// fallback to checking if the referenced script is packaged with this
+		// node package
+		externalScriptPath = path.resolve(__dirname, externalScriptPath)
+	}
 
   return new Promise(function (resolve, reject) {
     debug(`Trying to run the external script from ${externalScriptPath}`);

options.json

@@ -1,4 +1,4 @@
 {
 	"title" : "^([a-z]+) #(\\d+) (.*)$",
 	"meaning" : ["type", "issue", "title"]
-}
+}

templates/issuelink-markdown.ejs

@@ -0,0 +1,9 @@
+# Release Notes
+## <%= range %>
+<% commits.forEach(function (commit) { %>
+* __[<%= commit.issue %>](<%= commit.issueLink %>) <%= commit.title %>__
+
+    [<%= commit.authorName %>](mailto:<%= commit.authorEmail %>) - <%= commit.committerDate %>
+
+    <%= commit.messageLines.join("\n    ") %>
+<% }) %>