feat(nx-ghpages): add support for writing CNAME file

nx-dotnet · Jul 27, 2024 · 3a098f0 · 3a098f0
1 parent d349830
commit 3a098f0
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/packages/nx-ghpages/src/executors/deploy/executor.ts b/packages/nx-ghpages/src/executors/deploy/executor.ts
@@ -26,6 +26,11 @@ export default async function deployExecutor(options: BuildExecutorSchema) {
     };
   }
 
+  if (options.CNAME) {
+    logger.info(`Creating CNAME file for ${options.CNAME} in ${directory}`);
+    writeFileSync(join(directory, 'CNAME'), options.CNAME);
+  }
+
   logger.info('Setting up git remote');
 
   if (!(await exists(join(directory, '.git')))) {

diff --git a/packages/nx-ghpages/src/executors/deploy/schema.d.ts b/packages/nx-ghpages/src/executors/deploy/schema.d.ts
@@ -6,4 +6,5 @@ export interface BuildExecutorSchema {
   baseBranch: string;
   syncWithBaseBranch: boolean;
   syncStrategy: 'rebase' | 'merge';
+  CNAME: string;
 }
diff --git a/packages/nx-ghpages/src/executors/deploy/schema.json b/packages/nx-ghpages/src/executors/deploy/schema.json
@@ -38,6 +38,9 @@
       "description": "Git command to use to sync the gh-pages branch with the base branch",
       "enum": ["rebase", "merge"],
       "default": "rebase"
+    "CNAME": {
+      "type": "string",
+      "description": "Custom domain to use for the gh-pages branch. Applied by creating a CNAME file in the root of the gh-pages branch"
     }
   },
   "required": ["remote", "directory"]