From 452d217b930971faa25fe4e9647bfd3567d897b1 Mon Sep 17 00:00:00 2001 From: achingbrain Date: Mon, 8 Jan 2024 15:17:46 +0100 Subject: [PATCH 1/2] feat: support cname for docs publishing Expose the `cname` option from `gh-pages` to support publishing docs on a custom domain. --- src/docs.js | 4 +++- src/types.ts | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/docs.js b/src/docs.js index a40964e98..5a0dc0ebb 100644 --- a/src/docs.js +++ b/src/docs.js @@ -120,6 +120,7 @@ async function findMonorepoEntryPoints () { * @property {string} PublishDocsConfig.email * @property {string} PublishDocsConfig.message * @property {string} PublishDocsConfig.directory + * @property {string} [PublishDocsConfig.cname] */ /** @@ -138,7 +139,8 @@ const publishDocs = async (config) => { user: { name: config.user, email: config.email - } + }, + cname: config.cname } ) } diff --git a/src/types.ts b/src/types.ts index 7a1053b06..27c5356ce 100644 --- a/src/types.ts +++ b/src/types.ts @@ -170,6 +170,10 @@ interface DocsOptions { * Where to build the documentation */ directory: string + /** + * If set a CNAME file will be written with a custom domain + */ + cname?: string } interface DocsVerifierOptions { From 886b11eae93e31ca4671423b3190935adb374154 Mon Sep 17 00:00:00 2001 From: achingbrain Date: Mon, 8 Jan 2024 15:22:40 +0100 Subject: [PATCH 2/2] chore: set cname --- src/cmds/docs.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/cmds/docs.js b/src/cmds/docs.js index e6b72fae2..6a9102b63 100644 --- a/src/cmds/docs.js +++ b/src/cmds/docs.js @@ -55,6 +55,11 @@ export default { type: 'string', describe: 'Where to build the documentation', default: userConfig.docs.directory + }, + cname: { + type: 'string', + describe: 'A custom domain pointed at the gh-pages branch', + default: userConfig.docs.cname } }) },