github/codeql-action
1
0
Fork 0
mirror of https://github.com/github/codeql-action.git synced 2026-10-03 17:41:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add CODE_SCANNING_* vars to EnvVar enum

Browse Source
This commit is contained in:
Michael B. Gale
2026-07-09 14:47:32 +01:00
parent 97b52d19da
commit 4b164dbc17
4 changed files with 23 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
lib/entry-points.js generated
View File

@@ -145425,8 +145425,10 @@ function getPullRequestBranches(env = getEnv()) {
head: pullRequest.head.label
};
}
const codeScanningRef = env.getOptional("CODE_SCANNING_REF");
const codeScanningBaseBranch = env.getOptional("CODE_SCANNING_BASE_BRANCH");
const codeScanningRef = env.getOptional("CODE_SCANNING_REF" /* CODE_SCANNING_REF */);
const codeScanningBaseBranch = env.getOptional(
"CODE_SCANNING_BASE_BRANCH" /* CODE_SCANNING_BASE_BRANCH */
);
if (codeScanningRef && codeScanningBaseBranch) {
return {
base: codeScanningBaseBranch,

6
src/actions-util.ts
View File

@@ -429,8 +429,10 @@ export function getPullRequestBranches(
// PR analysis under Default Setup does not have the pull_request context,
// but it should set CODE_SCANNING_REF and CODE_SCANNING_BASE_BRANCH.
const codeScanningRef = env.getOptional("CODE_SCANNING_REF");
const codeScanningBaseBranch = env.getOptional("CODE_SCANNING_BASE_BRANCH");
const codeScanningRef = env.getOptional(EnvVar.CODE_SCANNING_REF);
const codeScanningBaseBranch = env.getOptional(
EnvVar.CODE_SCANNING_BASE_BRANCH,
);
if (codeScanningRef && codeScanningBaseBranch) {
return {
base: codeScanningBaseBranch,

12
src/environment.ts
View File

@@ -17,6 +17,18 @@ export enum EnvVar {
*/
CLI_VERBOSITY = "CODEQL_VERBOSITY",
/**
* Set by Default Setup to the base branch of the PR being analysed, if analysing a PR.
* This is needed because the `pull_request` context is not available for `dynamic` events.
*/
CODE_SCANNING_BASE_BRANCH = "CODE_SCANNING_BASE_BRANCH",
/**
* Set by Default Setup to the full ref being analysed, if analysing a PR.
* This is needed because the `pull_request` context is not available for `dynamic` events.
*/
CODE_SCANNING_REF = "CODE_SCANNING_REF",
/**
* `PersistedVersionInfo` for the CodeQL CLI, so later Actions steps can reuse it instead of
* invoking `codeql version` again.

5
src/setup-codeql.test.ts
View File

@@ -7,6 +7,7 @@ import * as sinon from "sinon";
import * as actionsUtil from "./actions-util";
import * as api from "./api-client";
import { EnvVar } from "./environment";
import { Feature } from "./feature-flags";
import { getRunnerLogger } from "./logging";
import { getCacheRestoreKeyPrefix } from "./overlay/caching";
@@ -637,8 +638,8 @@ test.serial(
async (t) => {
await withTmpDir(async (tmpDir) => {
setupActionsVars(tmpDir, tmpDir);
process.env["CODE_SCANNING_REF"] = "refs/heads/feature-branch";
process.env["CODE_SCANNING_BASE_BRANCH"] = "main";
process.env[EnvVar.CODE_SCANNING_REF] = "refs/heads/feature-branch";
process.env[EnvVar.CODE_SCANNING_BASE_BRANCH] = "main";
sinon.stub(api, "getAutomationID").resolves("test/");
const listStub = sinon.stub(api, "listActionsCaches").resolves([