From 96501a33aca65626acc8abecc8828308ea02e5d0 Mon Sep 17 00:00:00 2001 From: "Michael B. Gale" Date: Tue, 13 Oct 2026 17:28:17 +0100 Subject: [PATCH] Use `getCurrentInstance()` --- lib/entry-points.js | 19 +++++++++++-------- src/api-client.ts | 10 +++++++--- src/init-action.ts | 4 ++-- src/setup-codeql-action.ts | 6 +++--- src/upload-lib.ts | 7 ++++--- 5 files changed, 27 insertions(+), 19 deletions(-) diff --git a/lib/entry-points.js b/lib/entry-points.js index 0a0e56eec..47dc7c001 100644 --- a/lib/entry-points.js +++ b/lib/entry-points.js @@ -170660,6 +170660,12 @@ function parseGitHubUrl(inputUrl) { } return url2.toString(); } +function getCurrentInstance(env) { + return { + url: env.getRequired("GITHUB_SERVER_URL" /* GITHUB_SERVER_URL */), + apiURL: env.getRequired("GITHUB_API_URL" /* GITHUB_API_URL */) + }; +} // src/repository.ts function isRepositoryNwoStr(val) { @@ -170749,8 +170755,7 @@ function createApiClientWithDetails(apiDetails, { allowExternal = false, proxy = function getApiDetails(env = getEnv()) { return { auth: getRequiredInput("token"), - url: env.getRequired("GITHUB_SERVER_URL" /* GITHUB_SERVER_URL */), - apiURL: env.getRequired("GITHUB_API_URL" /* GITHUB_API_URL */) + ...getCurrentInstance(env) }; } function getApiClient(env = getEnv()) { @@ -180013,6 +180018,7 @@ async function shouldDisableCombineSarifFiles(sarifObjects, githubVersion) { return true; } async function combineSarifFilesUsingCLI(sarifFiles, gitHubVersion, features, logger2) { + const env = getEnv(); logger2.info("Combining SARIF files using the CodeQL CLI"); const sarifObjects = sarifFiles.map(readSarifFile); const deprecationWarningMessage = gitHubVersion.type === "GitHub Enterprise Server" /* GHES */ ? "and will be removed in GitHub Enterprise Server 3.18" : "and will be removed in July 2025"; @@ -180045,8 +180051,7 @@ async function combineSarifFilesUsingCLI(sarifFiles, gitHubVersion, features, lo externalRepoAuth: getOptionalInput( "external-repository-token" ), - url: getRequiredEnvParam("GITHUB_SERVER_URL"), - apiURL: getRequiredEnvParam("GITHUB_API_URL") + ...getCurrentInstance(env) }; const codeQLDefaultVersionInfo = await features.getEnabledDefaultCliVersions(gitHubVersion.type); const initCodeQLResult = await initCodeQL( @@ -186452,8 +186457,7 @@ async function run3(actionState) { apiDetails = { auth: getRequiredInput("token"), externalRepoAuth: getOptionalInput("external-repository-token"), - url: actionState.env.getRequired("GITHUB_SERVER_URL" /* GITHUB_SERVER_URL */), - apiURL: actionState.env.getRequired("GITHUB_API_URL" /* GITHUB_API_URL */) + ...getCurrentInstance(actionState.env) }; const gitHubVersion = await getGitHubVersion(); checkGitHubVersionInRange(gitHubVersion, logger2); @@ -187495,8 +187499,7 @@ async function run6(actionState) { const apiDetails = { auth: getRequiredInput("token"), externalRepoAuth: getOptionalInput("external-repository-token"), - url: actionState.env.getRequired("GITHUB_SERVER_URL" /* GITHUB_SERVER_URL */), - apiURL: actionState.env.getRequired("GITHUB_API_URL" /* GITHUB_API_URL */) + ...getCurrentInstance(actionState.env) }; const gitHubVersion = await getGitHubVersion(); checkGitHubVersionInRange(gitHubVersion, logger2); diff --git a/src/api-client.ts b/src/api-client.ts index e1e5dcc0a..48313dbba 100644 --- a/src/api-client.ts +++ b/src/api-client.ts @@ -13,7 +13,6 @@ import { import type { ActionState } from "./action-common"; import { getActionVersion, getRequiredInput } from "./actions-util"; import { - ActionsEnvVars, EnvVar, ReadOnlyEnv, RegistryProxyVars, @@ -21,6 +20,7 @@ import { exportEnvVar, } from "./environment"; import { + getCurrentInstance, GITHUB_DOTCOM_URL, parseGitHubUrl, type GitHubApiCombinedDetails, @@ -154,11 +154,15 @@ function createApiClientWithDetails( return new retryingOctokit(opts); } +/** + * Gets a `GitHubApiDetails` object describing the GitHub instance we are currently running on. + * + * @param env The environment variables to read. + */ export function getApiDetails(env: ReadOnlyEnv = getEnv()): GitHubApiDetails { return { auth: getRequiredInput("token"), - url: env.getRequired(ActionsEnvVars.GITHUB_SERVER_URL), - apiURL: env.getRequired(ActionsEnvVars.GITHUB_API_URL), + ...getCurrentInstance(env), }; } diff --git a/src/init-action.ts b/src/init-action.ts index 5376763b5..f58d4ccca 100644 --- a/src/init-action.ts +++ b/src/init-action.ts @@ -50,6 +50,7 @@ import { loadRepositoryProperties, RepositoryPropertyName, } from "./feature-flags/properties"; +import * as github from "./github"; import { checkInstallPython311, checkPacksForOverlayCompatibility, @@ -233,8 +234,7 @@ async function run( apiDetails = { auth: getRequiredInput("token"), externalRepoAuth: getOptionalInput("external-repository-token"), - url: actionState.env.getRequired(ActionsEnvVars.GITHUB_SERVER_URL), - apiURL: actionState.env.getRequired(ActionsEnvVars.GITHUB_API_URL), + ...github.getCurrentInstance(actionState.env), }; const gitHubVersion = await getGitHubVersion(); diff --git a/src/setup-codeql-action.ts b/src/setup-codeql-action.ts index 1344b66b7..757b26fac 100644 --- a/src/setup-codeql-action.ts +++ b/src/setup-codeql-action.ts @@ -17,9 +17,10 @@ import { getGitHubVersion } from "./api-client"; import { CodeQL } from "./codeql"; import { ComputedInput, getToolsInput } from "./config/inputs"; import { getRawLanguagesNoAutodetect } from "./config-utils"; -import { ActionsEnvVars, EnvVar } from "./environment"; +import { EnvVar } from "./environment"; import { initFeatures } from "./feature-flags"; import { loadRepositoryProperties } from "./feature-flags/properties"; +import * as github from "./github"; import { initCodeQL } from "./init"; import { Logger } from "./logging"; import { getRepositoryNwo } from "./repository"; @@ -112,8 +113,7 @@ async function run( const apiDetails = { auth: getRequiredInput("token"), externalRepoAuth: getOptionalInput("external-repository-token"), - url: actionState.env.getRequired(ActionsEnvVars.GITHUB_SERVER_URL), - apiURL: actionState.env.getRequired(ActionsEnvVars.GITHUB_API_URL), + ...github.getCurrentInstance(actionState.env), }; const gitHubVersion = await getGitHubVersion(); diff --git a/src/upload-lib.ts b/src/upload-lib.ts index 21f3417ff..3c46c1519 100644 --- a/src/upload-lib.ts +++ b/src/upload-lib.ts @@ -18,6 +18,7 @@ import { ActionsEnvVars, EnvVar, exportEnvVar } from "./environment"; import { FeatureEnablement } from "./feature-flags"; import * as fingerprints from "./fingerprints"; import * as gitUtils from "./git-utils"; +import * as github from "./github"; import { initCodeQL } from "./init"; import { Logger } from "./logging"; import { getRepositoryNwo, RepositoryNwo } from "./repository"; @@ -33,7 +34,6 @@ import * as util from "./util"; import { ConfigurationError, getErrorMessage, - getRequiredEnvParam, GitHubVariant, GitHubVersion, satisfiesGHESVersion, @@ -104,6 +104,8 @@ async function combineSarifFilesUsingCLI( features: FeatureEnablement, logger: Logger, ): Promise> { + const env = util.getEnv(); + logger.info("Combining SARIF files using the CodeQL CLI"); const sarifObjects = sarifFiles.map(sarif.readSarifFile); @@ -152,8 +154,7 @@ async function combineSarifFilesUsingCLI( externalRepoAuth: actionsUtil.getOptionalInput( "external-repository-token", ), - url: getRequiredEnvParam("GITHUB_SERVER_URL"), - apiURL: getRequiredEnvParam("GITHUB_API_URL"), + ...github.getCurrentInstance(env), }; const codeQLDefaultVersionInfo =