feat: make exit 0 possible when commits required but missing (#984)

* feat: make exit 0 possible when commits required but missing

* fix: removed dummy code

---------

Co-authored-by: Lars Kappert <lars@webpro.nl>

bin/release-it.js

@@ -38,5 +38,5 @@ const options = parseCliArguments([].slice.call(process.argv, 2));
 updater({ pkg: pkg }).notify();
 release(options).then(
   () => process.exit(0),
-  () => process.exit(1)
+  ({ code }) => process.exit(Number.isInteger(code) ? code : 1)
 );

config/release-it.json

@@ -6,6 +6,7 @@
     "requireBranch": false,
     "requireUpstream": true,
     "requireCommits": false,
+    "requireCommitsFail": true,
     "commitsPath": "",
     "addUntrackedFiles": false,
     "commit": true,

lib/plugin/git/Git.js

@@ -47,7 +47,7 @@ class Git extends GitBase {
       throw e(`No upstream configured for current branch.${EOL}Please set an upstream branch.`, docs);
     }
     if (this.options.requireCommits && (await this.getCommitsSinceLatestTag(this.options.commitsPath)) === 0) {
-      throw e(`There are no commits since the latest tag.`, docs);
+      throw e(`There are no commits since the latest tag.`, docs, this.options.requireCommitsFail);
     }
   }
 

lib/util.js

@@ -89,7 +89,11 @@ const parseVersion = raw => {
   };
 };
 
-const e = (message, docs) => new Error(docs ? `${message}${EOL}Documentation: ${docs}${EOL}` : message);
+const e = (message, docs, fail = true) => {
+  const error = new Error(docs ? `${message}${EOL}Documentation: ${docs}${EOL}` : message);
+  error.code = fail ? 1 : 0;
+  return error;
+};
 
 export {
   getSystemInfo,

test/git.init.js

@@ -72,6 +72,20 @@ test.serial('should not throw if there are commits', async t => {
   await t.notThrowsAsync(gitClient.init());
 });
 
+test.serial('should fail (exit code 1) if there are no commits', async t => {
+  const options = { git: { requireCommits: true } };
+  const gitClient = factory(Git, { options });
+  sh.exec('git tag 1.0.0');
+  await t.throwsAsync(gitClient.init(), { code: 1 });
+});
+
+test.serial('should not fail (exit code 0) if there are no commits', async t => {
+  const options = { git: { requireCommits: true, requireCommitsFail: false } };
+  const gitClient = factory(Git, { options });
+  sh.exec('git tag 1.0.0');
+  await t.throwsAsync(gitClient.init(), { code: 0 });
+});
+
 test.serial('should throw if there are no commits in specified path', async t => {
   const options = { git: { requireCommits: true, commitsPath: 'dir' } };
   const gitClient = factory(Git, { options });