feat(nx-ghpages): add option to customize commit message to gh-pages (

#542) Co-authored-by: Craigory Coppola <craigorycoppola@gmail.com>
nx-dotnet · Oct 18, 2022 · cff00e0 · cff00e0
1 parent 374e30f
commit cff00e0
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -5,7 +5,9 @@
 # NxDotnet
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+
 [![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)
+
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 [![Join the chat at https://gitter.im/nx-dotnet-plugin/community](https://badges.gitter.im/nx-dotnet-plugin/community.svg)](https://gitter.im/nx-dotnet-plugin/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Run CI checks](https://github.com/nx-dotnet/nx-dotnet/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/nx-dotnet/nx-dotnet/actions/workflows/main.yml)

diff --git a/docs/nx-ghpages/executors/deploy.md b/docs/nx-ghpages/executors/deploy.md
@@ -17,3 +17,7 @@ Deploy a page to a specified repository&#39;s gh-pages branch.
 ### remoteName
 
 - (string): Name of the remote to push to
+
+### commitMessage
+
+- (string): Message of the git commit to gh-pages branch
diff --git a/packages/nx-ghpages/src/executors/deploy/executor.spec.ts b/packages/nx-ghpages/src/executors/deploy/executor.spec.ts
@@ -21,6 +21,7 @@ const options: BuildExecutorSchema = {
   directory: '',
   remote: '',
   remoteName: '',
+  commitMessage: '',
 };
 
 describe('Build Executor', () => {

diff --git a/packages/nx-ghpages/src/executors/deploy/executor.ts b/packages/nx-ghpages/src/executors/deploy/executor.ts
@@ -48,7 +48,7 @@ export default async function deployExecutor(options: BuildExecutorSchema) {
   logger.info('Authoring Commit');
 
   await exec(`git add .`, { cwd: directory });
-  await exec(` git commit -m "deploy to gh-pages (nx-ghpages)"`, {
+  await exec(` git commit -m "${options.commitMessage}"`, {
     cwd: directory,
   });
 

diff --git a/packages/nx-ghpages/src/executors/deploy/schema.d.ts b/packages/nx-ghpages/src/executors/deploy/schema.d.ts
@@ -2,4 +2,5 @@ export interface BuildExecutorSchema {
   remote: string;
   directory: string;
   remoteName: string;
+  commitMessage: string;
 }
diff --git a/packages/nx-ghpages/src/executors/deploy/schema.json b/packages/nx-ghpages/src/executors/deploy/schema.json
@@ -17,6 +17,11 @@
       "type": "string",
       "description": "Name of the remote to push to",
       "default": "origin"
+    },
+    "commitMessage": {
+      "type": "string",
+      "description": "Message of the git commit to gh-pages branch",
+      "default": "chore: :rocket: deploy new version to Github Pages"
     }
   },
   "required": ["remote", "directory"]