nx 19.8.0-canary.20240919-7f4a877 → 19.8.0

package/src/command-line/release/utils/github.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGitHubRepoSlug = getGitHubRepoSlug;
+exports.getGitHubRepoData = getGitHubRepoData;
 exports.createOrUpdateGithubRelease = createOrUpdateGithubRelease;
-exports.resolveGithubToken = resolveGithubToken;
 exports.getGithubReleaseByTag = getGithubReleaseByTag;
 exports.formatReferences = formatReferences;
 const chalk = require("chalk");
@@ -12,22 +11,38 @@ const node_fs_1 = require("node:fs");
 const node_os_1 = require("node:os");
 const output_1 = require("../../../utils/output");
 const path_1 = require("../../../utils/path");
+const config_1 = require("../config/config");
 const print_changes_1 = require("./print-changes");
 const shared_1 = require("./shared");
 // axios types and values don't seem to match
 const _axios = require("axios");
 const axios = _axios;
-function getGitHubRepoSlug(remoteName = 'origin') {
+function getGitHubRepoData(remoteName = 'origin', createReleaseConfig) {
     try {
         const remoteUrl = (0, node_child_process_1.execSync)(`git remote get-url ${remoteName}`, {
             encoding: 'utf8',
             stdio: 'pipe',
         }).trim();
+        // Use the default provider (github.com) if custom one is not specified or releases are disabled
+        let hostname = config_1.defaultCreateReleaseProvider.hostname;
+        let apiBaseUrl = config_1.defaultCreateReleaseProvider.apiBaseUrl;
+        if (createReleaseConfig !== false &&
+            typeof createReleaseConfig !== 'string') {
+            hostname = createReleaseConfig.hostname;
+            apiBaseUrl = createReleaseConfig.apiBaseUrl;
+        }
         // Extract the 'user/repo' part from the URL
-        const regex = /github\.com[/:]([\w-]+\/[\w-]+)/;
+        const escapedHostname = hostname.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+        const regexString = `${escapedHostname}[/:]([\\w.-]+/[\\w.-]+)(\\.git)?`;
+        const regex = new RegExp(regexString);
         const match = remoteUrl.match(regex);
         if (match && match[1]) {
-            return match[1];
+            return {
+                hostname,
+                apiBaseUrl,
+                // Ensure any trailing .git is stripped
+                slug: match[1].replace(/\.git$/, ''),
+            };
         }
         else {
             throw new Error(`Could not extract "user/repo" data from the resolved remote URL: ${remoteUrl}`);
@@ -37,9 +52,9 @@ function getGitHubRepoSlug(remoteName = 'origin') {
         return null;
     }
 }
-async function createOrUpdateGithubRelease(releaseVersion, changelogContents, latestCommit, { dryRun }) {
-    const githubRepoSlug = getGitHubRepoSlug();
-    if (!githubRepoSlug) {
+async function createOrUpdateGithubRelease(createReleaseConfig, releaseVersion, changelogContents, latestCommit, { dryRun }) {
+    const githubRepoData = getGitHubRepoData(undefined, createReleaseConfig);
+    if (!githubRepoData) {
         output_1.output.error({
             title: `Unable to create a GitHub release because the GitHub repo slug could not be determined.`,
             bodyLines: [
@@ -48,9 +63,11 @@ async function createOrUpdateGithubRelease(releaseVersion, changelogContents, la
         });
         process.exit(1);
     }
-    const token = await resolveGithubToken();
+    const token = await resolveGithubToken(githubRepoData.hostname);
     const githubRequestConfig = {
-        repo: githubRepoSlug,
+        repo: githubRepoData.slug,
+        hostname: githubRepoData.hostname,
+        apiBaseUrl: githubRepoData.apiBaseUrl,
         token,
     };
     let existingGithubReleaseForVersion;
@@ -76,7 +93,7 @@ async function createOrUpdateGithubRelease(releaseVersion, changelogContents, la
             throw err;
         }
     }
-    const logTitle = `https://github.com/${githubRepoSlug}/releases/tag/${releaseVersion.gitTag}`;
+    const logTitle = `https://${githubRepoData.hostname}/${githubRepoData.slug}/releases/tag/${releaseVersion.gitTag}`;
     if (existingGithubReleaseForVersion) {
         console.error(`${chalk.white('UPDATE')} ${logTitle}${dryRun ? chalk.keyword('orange')(' [dry-run]') : ''}`);
     }
@@ -215,7 +232,7 @@ async function syncGithubRelease(githubRequestConfig, release, existingGithubRel
         };
     }
 }
-async function resolveGithubToken() {
+async function resolveGithubToken(hostname) {
     // Try and resolve from the environment
     const tokenFromEnv = process.env.GITHUB_TOKEN || process.env.GH_TOKEN;
     if (tokenFromEnv) {
@@ -227,14 +244,14 @@ async function resolveGithubToken() {
         const yamlContents = await node_fs_1.promises.readFile(ghCLIPath, 'utf8');
         const { load } = require('@zkochan/js-yaml');
         const ghCLIConfig = load(yamlContents);
-        if (ghCLIConfig['github.com']) {
+        if (ghCLIConfig[hostname]) {
             // Web based session (the token is already embedded in the config)
-            if (ghCLIConfig['github.com'].oauth_token) {
-                return ghCLIConfig['github.com'].oauth_token;
+            if (ghCLIConfig[hostname].oauth_token) {
+                return ghCLIConfig[hostname].oauth_token;
             }
             // SSH based session (we need to dynamically resolve a token using the CLI)
-            if (ghCLIConfig['github.com'].user &&
-                ghCLIConfig['github.com'].git_protocol === 'ssh') {
+            if (ghCLIConfig[hostname].user &&
+                ghCLIConfig[hostname].git_protocol === 'ssh') {
                 return (0, node_child_process_1.execSync)(`gh auth token`, {
                     encoding: 'utf8',
                     stdio: 'pipe',
@@ -242,6 +259,9 @@ async function resolveGithubToken() {
             }
         }
     }
+    if (hostname !== 'github.com') {
+        console.log(`Warning: It was not possible to automatically resolve a GitHub token from your environment for hostname ${hostname}. If you set the GITHUB_TOKEN or GH_TOKEN environment variable, that will be used for GitHub API requests.`);
+    }
     return null;
 }
 async function getGithubReleaseByTag(config, tag) {
@@ -250,7 +270,7 @@ async function getGithubReleaseByTag(config, tag) {
 async function makeGithubRequest(config, url, opts = {}) {
     return (await axios(url, {
         ...opts,
-        baseURL: 'https://api.github.com',
+        baseURL: config.apiBaseUrl,
         headers: {
             ...opts.headers,
             Authorization: config.token ? `Bearer ${config.token}` : undefined,
@@ -270,27 +290,32 @@ async function updateGithubRelease(config, id, body) {
     });
 }
 function githubNewReleaseURL(config, release) {
-    return `https://github.com/${config.repo}/releases/new?tag=${release.version}&title=${release.version}&body=${encodeURIComponent(release.body)}`;
+    // Parameters taken from https://github.com/isaacs/github/issues/1410#issuecomment-442240267
+    let url = `https://${config.hostname}/${config.repo}/releases/new?tag=${release.version}&title=${release.version}&body=${encodeURIComponent(release.body)}&target=${release.commit}`;
+    if (release.prerelease) {
+        url += '&prerelease=true';
+    }
+    return url;
 }
 const providerToRefSpec = {
     github: { 'pull-request': 'pull', hash: 'commit', issue: 'issues' },
 };
-function formatReference(ref, repoSlug) {
+function formatReference(ref, repoData) {
     const refSpec = providerToRefSpec['github'];
-    return `[${ref.value}](https://github.com/${repoSlug}/${refSpec[ref.type]}/${ref.value.replace(/^#/, '')})`;
+    return `[${ref.value}](https://${repoData.hostname}/${repoData.slug}/${refSpec[ref.type]}/${ref.value.replace(/^#/, '')})`;
 }
-function formatReferences(references, repoSlug) {
+function formatReferences(references, repoData) {
     const pr = references.filter((ref) => ref.type === 'pull-request');
     const issue = references.filter((ref) => ref.type === 'issue');
     if (pr.length > 0 || issue.length > 0) {
         return (' (' +
             [...pr, ...issue]
-                .map((ref) => formatReference(ref, repoSlug))
+                .map((ref) => formatReference(ref, repoData))
                 .join(', ') +
             ')');
     }
     if (references.length > 0) {
-        return ' (' + formatReference(references[0], repoSlug) + ')';
+        return ' (' + formatReference(references[0], repoData) + ')';
     }
     return '';
 }

package/src/config/nx-json.d.ts

@@ -58,7 +58,14 @@ export interface NxReleaseChangelogConfiguration {
      * NOTE: if createRelease is set on a group of projects, it will cause the default releaseTagPattern of
      * "{projectName}@{version}" to be used for those projects, even when versioning everything together.
      */
-    createRelease?: 'github' | false;
+    createRelease?: false | 'github' | {
+        provider: 'github-enterprise-server';
+        hostname: string;
+        /**
+         * If not set, this will default to `https://${hostname}/api/v3`
+         */
+        apiBaseUrl?: string;
+    };
     /**
      * This can either be set to a string value that will be written to the changelog file(s)
      * at the workspace root and/or within project directories, or set to `false` to specify