feat: add options to sync the gh-pages branch with the base branch … (#815)

Author: tinesoft

docs/nx-ghpages/Executors/deploy.md

@@ -21,3 +21,15 @@ Deploy a page to a specified repository's gh-pages branch.
 ### commitMessage
 
 - (string): Message of the git commit to gh-pages branch
+
+### baseBranch
+
+- (string): Base branch to sync the gh-pages branch with
+
+### syncWithBaseBranch
+
+- (string): Indicate if the gh-pages branch should be synced with the base branch
+
+### syncStrategy
+
+- (string): Git command to use to sync the gh-pages branch with the base branch

packages/nx-ghpages/src/executors/deploy/executor.spec.ts

@@ -22,6 +22,9 @@ const options: BuildExecutorSchema = {
   remote: '',
   remoteName: '',
   commitMessage: '',
+  baseBranch: '',
+  syncWithBaseBranch: false,
+  syncStrategy: 'rebase',
 };
 
 describe('Build Executor', () => {

packages/nx-ghpages/src/executors/deploy/executor.ts

@@ -6,6 +6,7 @@ import { join } from 'path';
 import { promisify } from 'util';
 
 import { BuildExecutorSchema } from './schema';
+import { readNxJson } from 'nx/src/config/nx-json';
 
 const exec = promisify(execCallback);
 
@@ -60,6 +61,15 @@ export default async function deployExecutor(options: BuildExecutorSchema) {
     logger.warn('Resetting gh-pages branch, as it already exists.');
     await exec(`git checkout -B gh-pages`, { cwd: directory });
   }
+  if (options.syncWithBaseBranch) {
+    const baseBranch =
+      options.baseBranch || readNxJson()?.affected?.defaultBase || 'master';
+    const syncStrategy = options.syncStrategy;
+    await exec(`git ${syncStrategy} ${options.remoteName}/${baseBranch}`, {
+      cwd: directory,
+    });
+  }
+
   await exec(`git push -f --set-upstream ${options.remoteName} gh-pages`, {
     cwd: directory,
   });

packages/nx-ghpages/src/executors/deploy/schema.d.ts

@@ -3,4 +3,7 @@ export interface BuildExecutorSchema {
   directory: string;
   remoteName: string;
   commitMessage: string;
+  baseBranch: string;
+  syncWithBaseBranch: boolean;
+  syncStrategy: 'rebase' | 'merge';
 }

packages/nx-ghpages/src/executors/deploy/schema.json

@@ -22,6 +22,22 @@
       "type": "string",
       "description": "Message of the git commit to gh-pages branch",
       "default": "chore: :rocket: deploy new version to Github Pages"
+    },
+    "baseBranch": {
+      "type": "string",
+      "description": "Base branch to sync the gh-pages branch with",
+      "default": "master"
+    },
+    "syncWithBaseBranch": {
+      "type": "string",
+      "description": "Indicate if the gh-pages branch should be synced with the base branch",
+      "default": "false"
+    },
+    "syncStrategy": {
+      "type": "string",
+      "description": "Git command to use to sync the gh-pages branch with the base branch",
+      "enum": ["rebase", "merge"],
+      "default": "rebase"
     }
   },
   "required": ["remote", "directory"]