feat: add github-base-url option to publish to GHES and GHEC

Author: Jeroen-Claasens

README.md

@@ -39,7 +39,6 @@ variation of the [Angular preset][angular-preset] (seen
 1. If `--install` was provided (or `install: true` set in the config file) then
    run the `install` command of the package manager (`npm install`,
    `yarn install`, or `pnpm install`) you used to call this CLI.
-
    - **Important:** when you install `@favware/cliff-jumper` globally this will
      always default to `npm` because of how NodeJS works. Therefore, if you wish
      for it to be `yarn` or `npm` make sure to add it as dev dependency to your
@@ -169,14 +168,12 @@ Options:
                                            as latest an this option will essentially be ignored.
   --github-release-name-template [string]  Note that this is only supported if "--git-host-variant" is set to "github"
                                            A GitHub release name template to use. Defaults to an empty string, which means GitHub will use the tag name as the release name.
-                                           You can use "{{new-version}}" in your template which will be dynamically replaced with whatever the new version is that will be
-                                           published.
-                                           You can use "{{org}}" in your template, this will be replaced with the org provided through "-o", "--org" or the same value set in
-                                           your config file.
-                                           You can use "{{name}}" in your template, this will be replaced with the name provided through "-n", "--name" or the same value set in
-                                           your config file.
-                                           You can use "{{full-name}}" in your template, this will be replaced "{{name}}" (when "org" is not provided), or "@{{org}}/{{name}}"
-                                           (when "org" is provided).
+                                           You can use "{{new-version}}" in your template which will be dynamically replaced with whatever the new version is that will be published.
+                                           You can use "{{org}}" in your template, this will be replaced with the org provided through "-o", "--org" or the same value set in your config file.
+                                           You can use "{{name}}" in your template, this will be replaced with the name provided through "-n", "--name" or the same value set in your config file.
+                                           You can use "{{full-name}}" in your template, this will be replaced "{{name}}" (when "org" is not provided), or "@{{org}}/{{name}}" (when "org" is provided).
+  --github-base-url [string]               Note that this is only supported if "--git-host-variant" is set to "github"
+                                           The base URL for the GitHub API. Defaults to "https://api.github.com".
   -v, --verbose                            Whether to print verbose information (default: false)
   -h, --help                               display help for command
 ```
@@ -212,6 +209,7 @@ package). It should be named `.cliff-jumperrc`, optionally suffixed with
 - `--github-release-pre-release` maps to `githubReleasePrerelease`
 - `--github-release-latest` maps to `githubReleaseLatest`
 - `--github-release-name-template` maps to `githubReleaseNameTemplate`
+- `--github-base-url` maps to `githubBaseUrl`
 - `--verbose` maps to `verbose`
 
 When using `.cliff-jumperrc` or `.cliff-jumperrc.json` as your config file you
@@ -301,6 +299,7 @@ This library has opinionated defaults for its options. These are as follows:
 - `--github-release-pre-release` will default to `false`.
 - `--github-release-latest` will default to `true`.
 - `--github-release-name-template` will default to an empty string.
+- `--github-base-url` will default to `https://api.github.com`.
 - `--verbose` will default to `false`.
 
 ### Merging of config file, defaults and CLI provided flags

assets/cliff-jumper.schema.json

@@ -116,6 +116,11 @@
       "description": "Note that this is only supported if \"--git-host-variant\" is set to \"github\"\nA custom release name template to use.\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config file.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
       "type": "string"
     },
+    "githubBaseUrl": {
+      "description": "Note that this is only supported if \"--git-host-variant\" is set to \"github\"\nA custom GitHub base URL to use. This can be used for GHEC or GHES instances. This should be the full API URL, for example \"https://api.github.com\" for github.com, or \"https://octokit.ghe.com/api/v3\" for a GHEC instance.",
+      "type": "string",
+      "default": "https://api.github.com"
+    },
     "verbose": {
       "description": "Whether to print verbose information",
       "type": "boolean",

src/cli.ts

@@ -174,6 +174,13 @@ const command = new Command()
       'You can use "{{full-name}}" in your template, this will be replaced "{{name}}" (when "org" is not provided), or "@{{org}}/{{name}}" (when "org" is provided).'
     ].join('\n')
   )
+  .option(
+    '--github-base-url [string]',
+    [
+      'Note that this is only supported if "--git-host-variant" is set to "github"',
+      'The base URL for the GitHub API. Defaults to "https://api.github.com".'
+    ].join('\n')
+  )
   .option('-v, --verbose', 'Whether to print verbose information', false);
 
 const program = command.parse(process.argv);
@@ -207,6 +214,7 @@ logVerboseInfo(
     `${indent}github release pre-release: ${JSON.stringify(options.githubReleasePrerelease)}`,
     `${indent}github release latest: ${JSON.stringify(options.githubReleaseLatest)}`,
     `${indent}github release name template: ${JSON.stringify(options.githubReleaseNameTemplate)}`,
+    `${indent}github base URL: ${JSON.stringify(options.githubBaseUrl)}`,
     ''
   ],
   options.verbose

src/commands/create-github-release.ts

@@ -10,7 +10,8 @@ import type { Options } from 'commander';
 
 export function createGitHubRelease(options: Options, newVersion: string, changelogSection: string | undefined) {
   const HydratedOctokit = Octokit.plugin(retry).defaults({
-    userAgent: 'Cliff Jumper CLI/ (@favware/cliff-jumper) (https://github.com/favware/cliff-jumper/tree/main)'
+    userAgent: 'Cliff Jumper CLI/ (@favware/cliff-jumper) (https://github.com/favware/cliff-jumper/tree/main)',
+    baseUrl: options.githubBaseUrl || 'https://api.github.com'
   });
 
   return doActionAndLog('Creating release', async () => {

src/lib/interfaces.d.ts

@@ -29,5 +29,6 @@ declare module 'commander' {
     githubReleasePrerelease: boolean;
     githubReleaseLatest: boolean;
     githubReleaseNameTemplate: string;
+    githubBaseUrl: string;
   }
 }

src/lib/preflight-checks.ts

@@ -81,16 +81,25 @@ async function checkGitConfig(options: Options) {
 
   const gitRepo = getGitRepo(options);
   const gitToken = getGitToken(options);
-  const { gitHostVariant, githubRelease, githubReleaseDraft, githubReleasePrerelease, githubReleaseLatest, githubReleaseNameTemplate, pushTag } =
-    options;
+  const {
+    gitHostVariant,
+    githubRelease,
+    githubReleaseDraft,
+    githubReleasePrerelease,
+    githubReleaseLatest,
+    githubReleaseNameTemplate,
+    githubBaseUrl,
+    pushTag
+  } = options;
 
   if (
     !isNullishOrEmpty(gitRepo) ||
     githubRelease ||
     githubReleaseDraft ||
     githubReleasePrerelease ||
     githubReleaseLatest ||
-    !isNullishOrEmpty(githubReleaseNameTemplate)
+    !isNullishOrEmpty(githubReleaseNameTemplate) ||
+    !isNullishOrEmpty(githubBaseUrl)
   ) {
     if (isNullishOrEmpty(gitToken)) {
       logVerboseError({
@@ -111,10 +120,14 @@ async function checkGitConfig(options: Options) {
       () => {
         if (
           (!githubRelease || !pushTag) &&
-          (githubReleaseDraft || githubReleasePrerelease || githubReleaseLatest || !isNullishOrEmpty(githubReleaseNameTemplate))
+          (githubReleaseDraft ||
+            githubReleasePrerelease ||
+            githubReleaseLatest ||
+            !isNullishOrEmpty(githubReleaseNameTemplate) ||
+            !isNullishOrEmpty(githubBaseUrl))
         ) {
           throw new Error(
-            'You can only use --github-release-draft, --github-release-latest, --github-release-name-template, and --github-release-pre-release when both --github-release and --push-tag are provided'
+            'You can only use --github-release-draft, --github-release-latest, --github-release-name-template, --github-base-url, and --github-release-pre-release when both --github-release and --push-tag are provided'
           );
         }
       }