moved history stuff to release-history package; internal refactor; ad…

…ded history now contains commit links
stbaer · Jan 18, 2017 · be4bfe7 · be4bfe7
1 parent 978aadd
commit be4bfe7
Show file tree

Hide file tree

Showing 11 changed files with 169 additions and 150 deletions.
diff --git a/History.md b/History.md
@@ -1,59 +1,76 @@
-###1.4.1 — *January 9, 2017*
 
-  * fix bin entry in package.json
 
-###1.4.0 — *January 9, 2017*
+###Release 1.4.1
+>*January 9, 2017*
+ * fix bin entry in package.json [d5b0d27](git@github.com:stbaer/gf-release.gitcommit/d5b0d279b5093bbb9c33f1343d20c58ca1490e6c)
+
+###Release 1.4.0
+>*January 9, 2017*
+ * added engines field to package.json [5546377](git@github.com:stbaer/gf-release.gitcommit/5546377403474054ecaa0fd2a8c0aea6eb323351)
+ * change: renamed release.js to gf-release.js [3df75bf](git@github.com:stbaer/gf-release.gitcommit/3df75bfd72652438ec32754696866db181f67707)
+ * lint / xo fixes [4c5b00a](git@github.com:stbaer/gf-release.gitcommit/4c5b00a1f4701af156a79e1872ae81d53bfa48f2)
+ * updated shelljs to 0.7.6 [8bd09a1](git@github.com:stbaer/gf-release.gitcommit/8bd09a1e17a14ff8cebd08d19724af6b3028420b)
+ * removed console.log [656e178](git@github.com:stbaer/gf-release.gitcommit/656e17852dd536ec7868f70c2f5ea74ea604f2c2)
+
+###Release 1.3.0
+>*January 8, 2017*
+ * added history commit message include and exclude filters [dc354aa](git@github.com:stbaer/gf-release.gitcommit/dc354aad2bfc6cc0d5e601eb2abf3efc982992d2)
+ * minor cleanup in prompt messages [ccf704b](git@github.com:stbaer/gf-release.gitcommit/ccf704bf538b31d96b22cf625d604f9074f4a1e5)
+
+###Release 1.2.1
+>*January 8, 2017*
+ * fixed typo [4245939](git@github.com:stbaer/gf-release.gitcommit/4245939e60b7454d87a83a364c33fdc8ce54c307)
+
+###Release 1.2.0
+>*January 8, 2017*
+ * fixed xo errors [9dcad0f](git@github.com:stbaer/gf-release.gitcommit/9dcad0f7f79ce506848994cfdb14aeb61f2535ed)
+ * minor cleanup [e357624](git@github.com:stbaer/gf-release.gitcommit/e3576242b0ca89dc89e44a014018eb37a8895a19)
+ * - new: prompt for npm publish, can be disabled via cli [c39b4d5](git@github.com:stbaer/gf-release.gitcommit/c39b4d56a5dc4929ea91ba3278ed54d21f65b9b1)
+ * - new: dry-run option, only logs the commands without changing anything [b55a449](git@github.com:stbaer/gf-release.gitcommit/b55a449448cdf5aca5bcc02544f7eab43f6f764b)
+ * updated yarn.lock [6fb9fb0](git@github.com:stbaer/gf-release.gitcommit/6fb9fb00bb1827f77b5757cca65d8a2f1f4d1a4b)
+
+###Release 1.1.4
+>*January 8, 2017*
+ * fix: get config from package.json [0d91998](git@github.com:stbaer/gf-release.gitcommit/0d91998131c53417e39561c7d0394cfc262df99e)
+
+###Release 1.1.3
+>*January 7, 2017*
+ * added preferGlobal to package.json [0d534d8](git@github.com:stbaer/gf-release.gitcommit/0d534d8390513d4cb90752b86f3e6141e1fe809e)
+ * fix: tag message; readme updated [d57a2d9](git@github.com:stbaer/gf-release.gitcommit/d57a2d9922e5e930d4bb9310b7da4f64dc209b8e)
+ * updated README.md [3f90e36](git@github.com:stbaer/gf-release.gitcommit/3f90e36827e4dd6f554d2e2ca9ca195e628aec78)
+
+###Release 1.1.2
+>*January 7, 2017*
+ * fix: commit command after version bump [f4d46cb](git@github.com:stbaer/gf-release.gitcommit/f4d46cb5e2723d788999c1383e5aecdf2103744b)
+ * change: release type defaults to patch now; fix: prompt.js exports [c8684ea](git@github.com:stbaer/gf-release.gitcommit/c8684eae21e6dd886f0e3be92b31962f90b8657f)
+ * change: no more prompt if the build should run, this depends on the config now [182edab](git@github.com:stbaer/gf-release.gitcommit/182edabf50a1d806ff94c4725d27ffab3208a35a)
+
+###Release 1.1.1
+>*January 7, 2017*
+ * fix: missing lib folder in package.json files entry [ab0316c](git@github.com:stbaer/gf-release.gitcommit/ab0316c17f16c23c229f1ab3bd8bd3c58597b7b1)
+
+###Release 1.1.0
+>*January 7, 2017*
+ * added empty History.md; added history config to package.json [c4c886f](git@github.com:stbaer/gf-release.gitcommit/c4c886feb5a54833046ebfb30a98670b55537e95)
+ * removed xo fix script - npm run xo -- --fix is good enough [0b6d7fd](git@github.com:stbaer/gf-release.gitcommit/0b6d7fd9b1e2bf9482a9b3fbf6fce49934891222)
+ * lint fix [b63f3b3](git@github.com:stbaer/gf-release.gitcommit/b63f3b3740acceae36fd5975bbf230f2aa633a44)
+ * option to create a history file [86a99f8](git@github.com:stbaer/gf-release.gitcommit/86a99f81d7a598b16e707230ea985ea2cc2780fa)
+ * added history module [13bb138](git@github.com:stbaer/gf-release.gitcommit/13bb138e244eacac52650fef5f33dd927274f527)
+ * license [4493051](git@github.com:stbaer/gf-release.gitcommit/4493051b6789076faa1eb32781f489515400a8e3)
+ * fix: typo [51a39c1](git@github.com:stbaer/gf-release.gitcommit/51a39c1ac642b6bac3e9cab51f0e862bdd15d6d6)
+
+###Release 1.0.1
+>*January 6, 2017*
+ * updated README [e2d9c7e](git@github.com:stbaer/gf-release.gitcommit/e2d9c7eedab33ad4d3bacae91c7547ca0a5bd493)
+ * updated prompt confirm message [2086170](git@github.com:stbaer/gf-release.gitcommit/2086170fb241ad424fa70583b70f0f3f90eaa057)
+
+###Release 1.0.0
+>*January 6, 2017*
+ * removed config for testing from package.json [ce7a095](git@github.com:stbaer/gf-release.gitcommit/ce7a095cf39330d449e877c6ec4ce4ee13cdd28c)
+
+###Release 0.1.0
+>*January 6, 2017*
+ * version 0.0.0 [7de3a7c](git@github.com:stbaer/gf-release.gitcommit/7de3a7c23cf2c4f2d4b7e35e537619bb00d19567)
+ * init gf-release [f5c8bd7](git@github.com:stbaer/gf-release.gitcommit/f5c8bd7e328dacc064a82f93697824a3698eac20)
 
-  * added engines field to package.json
-  * change: renamed release.js to gf-release.js
-  * lint / xo fixes
-  * updated shelljs to 0.7.6
-  * removed console.log
 
-###1.3.0 — *January 8, 2017*
-
-  * added history commit message include and exclude filters
-  * minor cleanup in prompt messages
-
-###1.2.1 — *January 8, 2017*
-
-  * fixed typo
-
-###1.2.0 — *January 8, 2017*
-
-  * fixed xo errors
-  * minor cleanup
-  * new: prompt for npm publish, can be disabled via cli - updated README.md
-  * new: dry-run option, only logs the commands without changing anything
-  * updated yarn.lock
-
-###1.1.4 — *January 8, 2017*
-
-  * fix: get config from package.json
-
-###1.1.3 — *January 7, 2017*
-
-  * added preferGlobal to package.json
-  * fix: tag message; readme updated
-  * updated README.md
-
-###1.1.2 — *January 7, 2017*
-
-  * fix: commit command after version bump
-  * change: release type defaults to patch now; fix: prompt.js exports
-  * change: no more prompt if the build should run, this depends on the config now
-
-###1.1.1 — *January 7, 2017*
-
-  * fix: missing lib folder in package.json files entry
-
-###1.1.0 — *January 7, 2017*
-
-  * added empty History.md; added history config to package.json
-  * removed xo fix script - npm run xo -- --fix is good enough
-  * lint fix
-  * option to create a history file
-  * added history module
-  * license
-  * fix: typo
-  * Merge branch 'release/1.0.1' into develop
diff --git a/bin/gf-release.js b/bin/gf-release.js
@@ -4,68 +4,115 @@ const semver = require('semver');
 const taggedVersions = require('tagged-versions');
 const inquirer = require('inquirer');
 const loudRejection = require('loud-rejection');
+const dateFormat = require('dateformat');
+const releaseHistory = require('release-history');
+const remoteUrl = require('remote-origin-url');
 
-const shellEx = require('../lib/ex').shellEx;
-const execSh = require('../lib/ex').execSh;
+const shellEx = require('../lib/helpers/ex').shellEx;
+const execSh = require('../lib/helpers/ex').execSh;
+const handleError = require('../lib/helpers/handle-error');
 const branchesUpToDate = require('../lib/branches-up-to-date');
 const bumpVersions = require('../lib/bump-versions');
-const handleError = require('../lib/handle-error');
-const spinner = require('../lib/spinner');
+const spinner = require('../lib/helpers/spinner');
 const prompts = require('../lib/prompts');
-const writeHistoryFile = require('../lib/history').writeHistoryFile;
 
 const config = require('../lib/config').config;
 const flags = require('../lib/config').flags;
 
+const getCommits = releaseHistory.getCommits;
+const commitsToMd = releaseHistory.commitsToMd;
 let currentVersion;
+let currentHash;
 let newVersion;
 
 loudRejection();
 
-const onGitFlowReleaseFinished = () => {
-    inquirer.prompt(prompts.pushThemAll)
-        .then(answer => {
-            if (answer.pushThemAll) {
-                spinner.create('Pushing branches and tags');
-                shellEx(`git push origin --all && git push origin --tags`, {silent: false});
-                spinner.succeed();
-
-                if (!flags.n) {
-                    inquirer.prompt(prompts.npmPublish)
-                        .then(answer => {
-                            if (answer.npmPublish) {
-                                spinner.create('Publishing to npm');
-                                shellEx('npm publish', {silent: false});
-                                spinner.succeed();
-                            }
-                        });
-                }
-            }
+const prependToHistoryFile = (currentHash, newVersion, file) => new Promise(resolve => {
+
+    const date = dateFormat(new Date(), 'longDate');
+
+    getCommits(null, currentHash)
+        .then((commits) => {
+            remoteUrl((err, url) => {
+                const historyString = commitsToMd(commits, {
+                    includeStrings: config.commitMessagesInclude,
+                    excludeStrings: config.commitMessagesExclude,
+                    version: newVersion, date, url
+                });
+                shellEx(`echo "${historyString}\n\n$(cat ${file})" > ${file}`);
+                resolve();
+            });
         });
+});
+
+
+const build = () => {
+    if (config.buildCommand) {
+        spinner.create('Building.');
+        shellEx(config.buildCommand);
+        spinner.succeed();
+    }
 };
 
-const onVersionsBumped = () => {
-    let commitCommand = 'git commit -am "bumped versions;';
+const pushAll = () => {
+    spinner.create('Pushing branches and tags');
+    shellEx(`git push origin --all && git push origin --tags`, {silent: false});
+    spinner.succeed();
+};
+
+const finishRelease = () => {
     let tagMessage = `-m "Release ${newVersion}"`;
     if (flags.m) {
         tagMessage = `-m "${flags.m}" `;
     }
 
-    if (config.historyFile) {
-        writeHistoryFile(currentVersion, newVersion, config.historyFile);
-        commitCommand += 'updated History.md;';
-    }
+    execSh(`git flow release finish ${tagMessage} ${newVersion}`)
+        .then(onGitFlowReleaseFinished);
+};
 
+const onHistoryDone = (commitCommand) => {
     if (config.buildCommand) {
-        spinner.create('Building.');
-        shellEx(config.buildCommand);
-        spinner.succeed();
+        build();
         commitCommand += 'updated build;';
     }
     shellEx(`${commitCommand}"`);
+    finishRelease();
+};
 
-    execSh(`git flow release finish ${tagMessage} ${newVersion}`)
-        .then(onGitFlowReleaseFinished);
+const onEverythingPushed = () => {
+    !flags.n && inquirer
+        .prompt(prompts.npmPublish)
+        .then(answer => {
+            if (answer.npmPublish) {
+                spinner.create('Publishing to npm');
+                shellEx('npm publish', {silent: false});
+                spinner.succeed();
+            }
+        });
+};
+
+const onGitFlowReleaseFinished = () => {
+    inquirer.prompt(prompts.pushThemAll)
+        .then(answer => {
+            if (answer.pushThemAll) {
+                pushAll();
+                onEverythingPushed();
+            }
+        });
+};
+
+
+const onVersionsBumped = () => {
+    let commitCommand = 'git commit -am "bumped versions;';
+
+    if (config.historyFile) {
+        prependToHistoryFile(currentHash, newVersion, config.historyFile)
+            .then(() => {
+                onHistoryDone(`${commitCommand} updated History.md`);
+            })
+    } else {
+        onHistoryDone(commitCommand);
+    }
 };
 
 const onRealeaseTypeChosen = choice => {
@@ -79,6 +126,7 @@ const onRealeaseTypeChosen = choice => {
 
 const onLastVersionResult = res => {
     currentVersion = res.version;
+    currentHash = res.hash;
     inquirer.prompt(prompts.releaseTypes)
         .then(onRealeaseTypeChosen);
 };

diff --git a/lib/branches-up-to-date.js b/lib/branches-up-to-date.js
@@ -1,5 +1,5 @@
-const shellEx = require('./ex').shellEx;
-const spinner = require('./spinner');
+const shellEx = require('./helpers/ex').shellEx;
+const spinner = require('./helpers/spinner');
 
 module.exports = branches => {
     const branchesString = branches.join(', ');

diff --git a/lib/bump-versions.js b/lib/bump-versions.js
@@ -1,5 +1,5 @@
 const updateJson = require('update-json');
-const handleError = require('./handle-error');
+const handleError = require('./helpers/handle-error');
 
 /**
  *

diff --git a/lib/config.js b/lib/config.js
@@ -21,10 +21,9 @@ const configDefault = {
 const config = Object.assign({}, configDefault, pkgConfig);
 
 if (flags.s) {
+    /** @type {boolean|null|string} */
     config.buildCommand = false;
 }
 
-// flags.d && console.log('\nflags:', flags, '\n\nConfig: \n', config, '\n');
-
 module.exports.config = config;
 module.exports.flags = flags;
diff --git a/lib/ex.js → lib/helpers/ex.js b/lib/ex.js → lib/helpers/ex.js
@@ -2,7 +2,7 @@ const shell = require('shelljs');
 const exec = require('exec-sh');
 const handleError = require('./handle-error');
 const log = require('./log');
-const flags = require('./config').flags;
+const flags = require('./../config').flags;
 
 /**
  *

diff --git a/lib/handle-error.js → lib/helpers/handle-error.js b/lib/handle-error.js → lib/helpers/handle-error.js
diff --git a/lib/log.js → lib/helpers/log.js b/lib/log.js → lib/helpers/log.js
diff --git a/lib/spinner.js → lib/helpers/spinner.js b/lib/spinner.js → lib/helpers/spinner.js
diff --git a/lib/history.js b/lib/history.js