Merge pull request #1 from alexcanessa/release-notes-tag-release

Release notes tag release

Author: alexcanessa

README.md

@@ -1,5 +1,5 @@
 # github-release-notes
-Node module which generates a release from the latest tag and compiles release notes based on commit messages between the last two tags.
+Node module which generates a release from the latest tag and compiles release notes based on commit messages between the last tag and the latest release.
 
 ## Installation
 

github-release-notes.js

@@ -30,19 +30,28 @@ function getOptions(args) {
 }
 
 /**
- * Get all the tags of the repo
+ * Create a release from a given tag (in the options)
  *
- * @return {Promise}
+ * @param  {Object} options The options to build the release:
+ * {
+ *   "tag_name": "v1.0.0",
+ *   "target_commitish": "master",
+ *   "name": "v1.0.0",
+ *   "body": "Description of the release",
+ *   "draft": false,
+ *   "prerelease": false
+ * }
  */
-function getAllTags() {
-   return new Promise(function (resolve, reject) {
-      repo.listTags(function(err, tags) {
-         if(err) {
-            reject(err);
-         } else {
-            resolve(tags);
-         }
-      });
+function makeRelease(releaseOptions) {
+   repo.makeRelease(releaseOptions, function (err, release) {
+      if(err) {
+         console.error(
+            (JSON.parse(err.request.responseText)).message + '\n'
+            + (JSON.parse(err.request.responseText)).errors[0].code
+         );
+      } else {
+         console.info(release.tag_name + ' successfully created!');
+      }
    });
 }
 
@@ -70,6 +79,30 @@ function commitMessages(commits) {
    });
 }
 
+/**
+ * Creates the options to make the release
+ *
+ * @param  {[string]} commitMessages The commit messages to create the release body
+ */
+function prepareRelease(tags, commitMessages) {
+   var body = commitMessages.filter(function (message) {
+      return !message.match('Merge');
+   }).map(createBody);
+
+   body.pop();
+
+   var releaseOptions = {
+      tag_name: tags[0].name,
+      name: releasePrefix + tags[0].name,
+      body: body.join('\n'),
+      draft: options.draft || false,
+      prerelease: options.prerelease || false
+   };
+
+
+   makeRelease(releaseOptions);
+}
+
 /**
  * Gets all the commits between two dates
  *
@@ -102,10 +135,10 @@ function getCommitsBetweenTwo(since, until) {
  * @param  {[Object]} tags List of all the tags in the repo
  * @return {[Promise]}     The promises which returns the dates
  */
-function getTagDates(tags) {
-   return [tags[0], tags[1]].map(function(tag) {
+function getTagDates(lastTag, lastRelease) {
+   return [lastTag, lastRelease].map(function (tag) {
       return new Promise(function (resolve, reject) {
-         repo.getCommit('master', tag.commit.sha, function(err, commit) {
+         repo.getCommit('master', tag.commit.sha, function (err, commit) {
             if(err) {
                reject(err);
             } else {
@@ -117,63 +150,58 @@ function getTagDates(tags) {
 }
 
 /**
- * Create a release from a given tag (in the options)
+ * Get all the tags of the repo
  *
- * @param  {Object} options The options to build the release:
- * {
- *   "tag_name": "v1.0.0",
- *   "target_commitish": "master",
- *   "name": "v1.0.0",
- *   "body": "Description of the release",
- *   "draft": false,
- *   "prerelease": false
- * }
+ * @return {Promise}
  */
-function makeRelease(releaseOptions) {
-   repo.makeRelease(releaseOptions, function (err, release) {
-      if(err) {
-         console.error(
-            (JSON.parse(err.request.responseText)).message + '\n'
-            + (JSON.parse(err.request.responseText)).errors[0].code
-         );
-      } else {
-         console.info(release.tag_name + 'successfully created!');
-      }
+function getLastTag(releaseTagName) {
+   return new Promise(function (resolve, reject) {
+      repo.listTags(function (err, tags) {
+         if(err) {
+            reject(err);
+         } else {
+            resolve(
+               tags.filter(function(tag, index) {
+                  return (index === 0 || tag.name === releaseTagName);
+               })
+            );
+         }
+      });
    });
 }
 
 /**
- * Creates the options to make the release
+ * Get the latest release
  *
- * @param  {[string]} commitMessages The commit messages to create the release body
+ * @return {Promise} The promise which resolves the tag name of the release
  */
-function prepareRelease(tags, commitMessages) {
-   var body = commitMessages.filter(function(message) {
-      return !message.match('Merge');
-   }).map(createBody);
-
-   body.pop();
-
-   var releaseOptions = {
-      tag_name: tags[0].name,
-      name: releasePrefix + tags[0].name,
-      body: body.join('\n'),
-      draft: options.draft || false,
-      prerelease: options.prerelease || false
-   };
-
-
-   makeRelease(releaseOptions);
+function getLatestRelease() {
+   return new Promise(function (resolve, reject) {
+      repo.getLatestRelease(function (err, release) {
+         if(err) {
+            reject(err);
+         } else {
+            resolve(release.tag_name);
+         }
+      });
+   });
 }
 
 /**
  * Get All the tags, get the dates, get the commits between those dates and prepeare the release
  */
 function init() {
-   getAllTags().then(function(tags) {
-      Promise.all(getTagDates(tags))
-         .then(function(data) {
-            getCommitsBetweenTwo(data[1], data[0]).then(prepareRelease.bind(null, tags));
+   getLatestRelease().then(function (releaseTagName) {
+      getLastTag(releaseTagName).then(function (tags) {
+         if(tags.length === 1) {
+            console.error('The latest tag is the latest release!');
+            return;
+         }
+
+         Promise.all(getTagDates(tags[0], tags[1]))
+            .then(function (data) {
+               getCommitsBetweenTwo(data[1], data[0]).then(prepareRelease.bind(null, tags));
+            });
          });
    });
 }