Add git.requireCommits feature to prevent empty releases (resolves #…

…500)
release-it · May 3, 2019 · d27587f · d27587f
1 parent a85b6df
commit d27587f
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/conf/release-it.json b/conf/release-it.json
@@ -9,6 +9,7 @@
     "changelog": "git log --pretty=format:\"* %s (%h)\" ${latestTag}...HEAD",
     "requireCleanWorkingDir": true,
     "requireUpstream": true,
+    "requireCommits": false,
     "addUntrackedFiles": false,
     "commit": true,
     "commitMessage": "Release ${version}",

diff --git a/lib/errors.js b/lib/errors.js
@@ -57,6 +57,12 @@ class GitUpstreamError extends ReleaseItError {
   }
 }
 
+class GitNoCommitsError extends ReleaseItError {
+  constructor() {
+    super('There are no commits since the latest tag.');
+  }
+}
+
 class GitNetworkError extends ReleaseItError {
   constructor(err, remoteUrl) {
     super(`Unable to fetch from ${remoteUrl}${EOL}${err.message}`);
@@ -94,6 +100,7 @@ module.exports = {
   GitRemoteUrlError,
   GitCleanWorkingDirError,
   GitUpstreamError,
+  GitNoCommitsError,
   GitCommitError,
   GitNetworkError,
   TokenError,

diff --git a/lib/plugin/git/Git.js b/lib/plugin/git/Git.js
@@ -2,7 +2,7 @@ const _ = require('lodash');
 const findUp = require('find-up');
 const GitBase = require('../GitBase');
 const prompts = require('./prompts');
-const { GitCleanWorkingDirError, GitUpstreamError, GitCommitError } = require('../../errors');
+const { GitCleanWorkingDirError, GitUpstreamError, GitNoCommitsError, GitCommitError } = require('../../errors');
 
 const noop = Promise.resolve();
 const invalidPushRepoRe = /^\S+@/;
@@ -26,6 +26,9 @@ class Git extends GitBase {
     if (this.options.requireUpstream && !(await this.hasUpstreamBranch())) {
       throw new GitUpstreamError();
     }
+    if (this.options.requireCommits && (await this.getCommitsSinceLatestTag()) === 0) {
+      throw new GitNoCommitsError();
+    }
   }
 
   async beforeRelease() {
@@ -69,6 +72,10 @@ class Git extends GitBase {
     return this.exec('git diff-index --quiet HEAD --', { options }).then(() => true, () => false);
   }
 
+  getCommitsSinceLatestTag() {
+    return this.exec('git rev-list $(git describe --tags --abbrev=0)..HEAD --count', { options }).then(Number);
+  }
+
   stage(file) {
     if (!file || !file.length) return noop;
     const files = _.castArray(file).join(' ');