3708898bf2
This PR ensures environment variables are set before any invocation of the CLI. Here is a list of vars that are set: https://github.com/github/codeql-coreql-team/issues/1124#issuecomment-852463521 This ensures the CLI knows the features and versions of the containing actions/runner. Additionally: - Fix the user agent so that it more closely aligns with user agent spec - Refactor environment variable initialization so that it all happens in one place and call. - Move Mode, getRequiredEnvParam, setMode, getMode out of actions-util and into util. actions-util is meant for utils only called by the action, not the runner. The `prepareLocalRunEnvironment()` method is most likely deprecated and should be removed. I originally added it because I had a way of working where I would run the action from my local machine to test out changes, but this was always a little flaky. So, I no longer use this way of working. I will probably remove it soon.
58 lines
No EOL
2.7 KiB
JavaScript
Generated
58 lines
No EOL
2.7 KiB
JavaScript
Generated
"use strict";
|
|
var __importStar = (this && this.__importStar) || function (mod) {
|
|
if (mod && mod.__esModule) return mod;
|
|
var result = {};
|
|
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
|
|
result["default"] = mod;
|
|
return result;
|
|
};
|
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
};
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
const path = __importStar(require("path"));
|
|
const githubUtils = __importStar(require("@actions/github/lib/utils"));
|
|
const console_log_level_1 = __importDefault(require("console-log-level"));
|
|
const actions_util_1 = require("./actions-util");
|
|
const util_1 = require("./util");
|
|
// eslint-disable-next-line import/no-commonjs
|
|
const pkg = require("../package.json");
|
|
var DisallowedAPIVersionReason;
|
|
(function (DisallowedAPIVersionReason) {
|
|
DisallowedAPIVersionReason[DisallowedAPIVersionReason["ACTION_TOO_OLD"] = 0] = "ACTION_TOO_OLD";
|
|
DisallowedAPIVersionReason[DisallowedAPIVersionReason["ACTION_TOO_NEW"] = 1] = "ACTION_TOO_NEW";
|
|
})(DisallowedAPIVersionReason = exports.DisallowedAPIVersionReason || (exports.DisallowedAPIVersionReason = {}));
|
|
exports.getApiClient = function (apiDetails, { allowLocalRun = false, allowExternal = false } = {}) {
|
|
if (util_1.isLocalRun() && !allowLocalRun) {
|
|
throw new Error("Invalid API call in local run");
|
|
}
|
|
const auth = (allowExternal && apiDetails.externalRepoAuth) || apiDetails.auth;
|
|
return new githubUtils.GitHub(githubUtils.getOctokitOptions(auth, {
|
|
baseUrl: getApiUrl(apiDetails.url),
|
|
userAgent: `CodeQL-${util_1.getMode()}/${pkg.version}`,
|
|
log: console_log_level_1.default({ level: "debug" }),
|
|
}));
|
|
};
|
|
function getApiUrl(githubUrl) {
|
|
const url = new URL(githubUrl);
|
|
// If we detect this is trying to connect to github.com
|
|
// then return with a fixed canonical URL.
|
|
if (url.hostname === "github.com" || url.hostname === "api.github.com") {
|
|
return "https://api.github.com";
|
|
}
|
|
// Add the /api/v3 API prefix
|
|
url.pathname = path.join(url.pathname, "api", "v3");
|
|
return url.toString();
|
|
}
|
|
// Temporary function to aid in the transition to running on and off of github actions.
|
|
// Once all code has been converted this function should be removed or made canonical
|
|
// and called only from the action entrypoints.
|
|
function getActionsApiClient(allowLocalRun = false) {
|
|
const apiDetails = {
|
|
auth: actions_util_1.getRequiredInput("token"),
|
|
url: util_1.getRequiredEnvParam("GITHUB_SERVER_URL"),
|
|
};
|
|
return exports.getApiClient(apiDetails, { allowLocalRun });
|
|
}
|
|
exports.getActionsApiClient = getActionsApiClient;
|
|
//# sourceMappingURL=api-client.js.map
|