Documentation and prepareRelease function

Author: alexcanessa

github-release-notes.js

@@ -45,16 +45,38 @@ function getAllTags() {
    });
 }
 
+/**
+ * Return a string with a - to be a bullet list (used for a mapping)
+ * 
+ * @param  {string} message
+ * 
+ * @return {string}
+ */
 function createBody(message) {
    return '- ' + message;
 }
 
+/**
+ * Transforms the commits to commit messages
+ * 
+ * @param  {[Object]} commits The array of object containing the commits
+ * 
+ * @return {[string]}
+ */
 function commitMessages(commits) {
    return commits.map(function (commit) {
       return commit.commit.message;
    });
 }
 
+/**
+ * Gets all the commits between two dates
+ * 
+ * @param  {string} since The since date in ISO
+ * @param  {string} until The until date in ISO
+ * 
+ * @return {Promise}      The promise which resolves the commit messages
+ */
 function getCommitsBetweenTwo(since, until) {
    var options = {
       since: since,
@@ -73,6 +95,12 @@ function getCommitsBetweenTwo(since, until) {
    });
 }
 
+/**
+ * Get the dates of the last two tags
+ * 
+ * @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) {
       return new Promise(function (resolve, reject) {
@@ -87,6 +115,19 @@ function getTagDates(tags) {
    })
 }
 
+/**
+ * Create a release from a given tag (in the options)
+ * 
+ * @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 makeRelease(options) {
    repo.makeRelease(options, function (err, release) {
       if(err) {
@@ -100,23 +141,39 @@ function makeRelease(options) {
    });
 }
 
-getAllTags().then(function(tags) {
-   Promise.all(getTagDates(tags))
-      .then(function(data) {
-         getCommitsBetweenTwo(data[1], data[0]).then(function (commitMessages) {
-            var body = commitMessages.filter(function(message) {
-               return !message.match('Merge');
-            }).map(createBody);
+/**
+ * Creates the options to make the release
+ * 
+ * @param  {[string]} commitMessages The commit messages to create the release body 
+ */
+function prepareRelease(commitMessages) {
+   var body = commitMessages.filter(function(message) {
+      return !message.match('Merge');
+   }).map(createBody);
+
+   body.pop();
 
-            body.pop();
+   var options = {
+      tag_name: tags[0].name,
+      name: tags[0].name,
+      body: body.join('\n'),
+      draft: options.draft || false,
+      prerelease: options.prerelease || false
+   };
 
-            var options = {
-               tag_name: tags[0].name,
-               name: tags[0].name,
-               body: body.join('\n')
-            };
+   makeRelease(options);
+}
 
-            makeRelease(options);
+/**
+ * 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);
          });
-      });
-});
+   });
+}
+
+init();