feat: force push to protected branch with explicit config (#813)

algolia · May 12, 2020 · 3647853 · 3647853
1 parent de2da75
commit 3647853
Show file tree

Hide file tree

Showing 6 changed files with 67 additions and 10 deletions.
diff --git a/packages/shipjs-lib/src/lib/config/defaultConfig.js b/packages/shipjs-lib/src/lib/config/defaultConfig.js
@@ -115,6 +115,7 @@ export default {
   getTagName: ({ version }) => `v${version}`,
   testCommandBeforeRelease: undefined, // ({ isYarn }) => isYarn ? 'yarn test' : 'npm run test',
   appName: undefined,
+  forcePushBranches: [],
   slack: {
     default: {
       username: 'Ship.js',

diff --git a/packages/shipjs/src/flow/prepare.js b/packages/shipjs/src/flow/prepare.js
@@ -49,10 +49,10 @@ async function prepare({
   const config = loadConfig(dir);
   const { currentVersion, baseBranch } = validate({ config, dir });
   validateMergeStrategy({ config });
-  const { remote } = config;
+  const { remote, forcePushBranches } = config;
   pull({ remote, currentBranch: baseBranch, dir, dryRun });
   fetchTags({ dir, dryRun });
-  push({ remote, currentBranch: baseBranch, dir, dryRun });
+  push({ remote, currentBranch: baseBranch, forcePushBranches, dir, dryRun });
   const currentTag = config.getTagName({ version: currentVersion });
   const { revisionRange } = await getRevisionRange({
     yes,

diff --git a/packages/shipjs/src/helper/__tests__/gitPush.spec.js b/packages/shipjs/src/helper/__tests__/gitPush.spec.js
@@ -93,4 +93,30 @@ describe('gitPush', () => {
       }
     `);
   });
+
+  it('force pushes', () => {
+    gitPush({
+      remote: 'origin',
+      refs: ['master', 'v1.2.3'],
+      forcePushBranches: ['master'],
+      dir: '.',
+      dryRun: false,
+    });
+    expect(print).toHaveBeenCalledTimes(0);
+    expect(run).toHaveBeenCalledTimes(2);
+    expect(run.mock.calls[0][0]).toMatchInlineSnapshot(`
+      Object {
+        "command": "git push -f origin master",
+        "dir": ".",
+        "dryRun": false,
+      }
+    `);
+    expect(run.mock.calls[1][0]).toMatchInlineSnapshot(`
+      Object {
+        "command": "git push origin v1.2.3",
+        "dir": ".",
+        "dryRun": false,
+      }
+    `);
+  });
 });
diff --git a/packages/shipjs/src/helper/gitPush.js b/packages/shipjs/src/helper/gitPush.js
@@ -5,7 +5,13 @@ import {
 } from 'shipjs-lib';
 import { print, run } from '../util';
 
-export default function gitPush({ remote, refs, dir, dryRun }) {
+export default function gitPush({
+  remote,
+  refs,
+  forcePushBranches = [],
+  dir,
+  dryRun,
+}) {
   const token = process.env.GITHUB_TOKEN;
   if (token) {
     if (!hasRemote('origin-with-token', dir)) {
@@ -20,7 +26,12 @@ export default function gitPush({ remote, refs, dir, dryRun }) {
       });
     }
     refs.forEach((ref) => {
-      run({ command: `git push origin-with-token ${ref}`, dir, dryRun });
+      const force = forcePushBranches.includes(ref);
+      run({
+        command: `git push${force ? ' -f' : ''} origin-with-token ${ref}`,
+        dir,
+        dryRun,
+      });
     });
     run({
       command: `git remote remove origin-with-token`,
@@ -30,8 +41,9 @@ export default function gitPush({ remote, refs, dir, dryRun }) {
     });
   } else {
     refs.forEach((ref) => {
+      const force = forcePushBranches.includes(ref);
       run({
-        command: `git push ${remote} ${ref}`,
+        command: `git push${force ? ' -f' : ''} ${remote} ${ref}`,
         dir,
         dryRun,
       });

diff --git a/packages/shipjs/src/step/prepare/push.js b/packages/shipjs/src/step/prepare/push.js
@@ -1,7 +1,13 @@
 import runStep from '../runStep';
 import { gitPush } from '../../helper';
 
-export default ({ remote, currentBranch, dir, dryRun }) =>
+export default ({ remote, currentBranch, forcePushBranches, dir, dryRun }) =>
   runStep({ title: 'Pushing to remote.' }, () => {
-    gitPush({ remote, refs: [currentBranch], dir, dryRun });
+    gitPush({
+      remote,
+      refs: [currentBranch],
+      forcePushBranches,
+      dir,
+      dryRun,
+    });
   });
diff --git a/packages/shipjs/src/step/release/gitPush.js b/packages/shipjs/src/step/release/gitPush.js
@@ -6,19 +6,31 @@ import { run } from '../../util';
 export default ({ tagName, config, dir, dryRun }) =>
   runStep({ title: 'Pushing to the remote.' }, () => {
     const currentBranch = getCurrentBranch(dir);
-    const { mergeStrategy, remote } = config;
+    const { mergeStrategy, remote, forcePushBranches } = config;
     const destinationBranch = getBranchNameToMergeBack({
       currentBranch,
       mergeStrategy,
     });
     if (currentBranch === destinationBranch) {
-      gitPush({ remote, refs: [currentBranch, tagName], dir, dryRun });
+      gitPush({
+        remote,
+        refs: [currentBranch, tagName],
+        forcePushBranches,
+        dir,
+        dryRun,
+      });
     } else {
       // currentBranch: 'master'
       // destinationBranch: 'develop'
       // flow: develop -> master -> (here) develop
       run({ command: `git checkout ${destinationBranch}`, dir, dryRun });
       run({ command: `git merge ${currentBranch}`, dir, dryRun });
-      gitPush({ remote, refs: [destinationBranch, tagName], dir, dryRun });
+      gitPush({
+        remote,
+        refs: [destinationBranch, tagName],
+        forcePushBranches,
+        dir,
+        dryRun,
+      });
     }
   });