Add support for required branch(es)

conf/release-it.json

@@ -3,6 +3,7 @@
   "git": {
     "changelog": "git log --pretty=format:\"* %s (%h)\" ${latestTag}...HEAD",
     "requireCleanWorkingDir": true,
+    "requireBranch": false,
     "requireUpstream": true,
     "requireCommits": false,
     "addUntrackedFiles": false,

docs/prerequisites.md

@@ -5,6 +5,20 @@ ways you can change release-it's behavior.
 
 ## Git
 
+### Required branch
+
+By default this is disabled, but release-it can exit the process when the current branch is not as configured:
+
+```json
+{
+  "git": {
+    "requireBranch": "master"
+  }
+}
+```
+
+Use an array to allow releases from more branch names.
+
 ### Clean working directory
 
 The working directory should be clean (i.e. `git status` should say something like this:

lib/errors.js

@@ -31,6 +31,12 @@ class GitRemoteUrlError extends ReleaseItError {
   }
 }
 
+class GitRequiredBranchError extends ReleaseItError {
+  constructor(requiredBranches) {
+    super(`Must be on branch ${requiredBranches}`);
+  }
+}
+
 class GitCleanWorkingDirError extends ReleaseItError {
   constructor() {
     super(
@@ -98,6 +104,7 @@ module.exports = {
   InvalidVersionError,
   InvalidConfigurationError,
   GitRemoteUrlError,
+  GitRequiredBranchError,
   GitCleanWorkingDirError,
   GitUpstreamError,
   GitNoCommitsError,

lib/plugin/git/Git.js

@@ -3,7 +3,13 @@ const findUp = require('find-up');
 const { quote } = require('shell-quote');
 const { format } = require('../../util');
 const GitBase = require('../GitBase');
-const { GitCleanWorkingDirError, GitUpstreamError, GitNoCommitsError, GitCommitError } = require('../../errors');
+const {
+  GitRequiredBranchError,
+  GitCleanWorkingDirError,
+  GitUpstreamError,
+  GitNoCommitsError,
+  GitCommitError
+} = require('../../errors');
 const prompts = require('./prompts');
 
 const noop = Promise.resolve();
@@ -21,6 +27,9 @@ class Git extends GitBase {
   }
 
   async init() {
+    if (this.options.requireBranch && !(await this.isRequiredBranch(this.options.requireBranch))) {
+      throw new GitRequiredBranchError(this.options.requireBranch);
+    }
     if (this.options.requireCleanWorkingDir && !(await this.isWorkingDirClean())) {
       throw new GitCleanWorkingDirError();
     }
@@ -53,6 +62,12 @@ class Git extends GitBase {
     await this.step({ enabled: push, task: () => this.push(), label: 'Git push', prompt: 'push' });
   }
 
+  async isRequiredBranch() {
+    const branch = await this.getBranchName();
+    const requiredBranches = _.castArray(this.options.requireBranch);
+    return requiredBranches.includes(branch);
+  }
+
   hasUpstreamBranch() {
     return this.exec('git symbolic-ref HEAD', { options })
       .then(refs => this.exec(`git for-each-ref --format="%(upstream:short)" ${refs}`, { options }).then(Boolean))

test/git.init.js

@@ -4,7 +4,13 @@ const Shell = require('../lib/shell');
 const Log = require('../lib/log');
 const Git = require('../lib/plugin/git/Git');
 const { git } = require('../conf/release-it.json');
-const { GitRemoteUrlError, GitCleanWorkingDirError, GitUpstreamError, GitNoCommitsError } = require('../lib/errors');
+const {
+  GitRequiredBranchError,
+  GitRemoteUrlError,
+  GitCleanWorkingDirError,
+  GitUpstreamError,
+  GitNoCommitsError
+} = require('../lib/errors');
 const { factory } = require('./util');
 const { mkTmpDir, gitAdd } = require('./util/helpers');
 
@@ -20,6 +26,14 @@ test.serial.beforeEach(t => {
   t.context = { gitClient, bare, target };
 });
 
+test.serial('should throw if on wrong branch', async t => {
+  const options = { git: { requireBranch: 'dev' } };
+  const gitClient = factory(Git, { options });
+  sh.exec('git remote remove origin');
+  const expected = { instanceOf: GitRequiredBranchError, message: /Must be on branch dev/ };
+  await t.throwsAsync(gitClient.init(), expected);
+});
+
 test.serial('should throw if there is no remote Git url', async t => {
   const { gitClient } = t.context;
   sh.exec('git remote remove origin');