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

Add EnvVar constant for analysis key

Browse Source
This commit is contained in:
Michael B. Gale
2026-01-19 13:41:38 +00:00
parent 644e2b9bd7
commit 055e6b6f36
14 changed files with 27 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
lib/analyze-action.js generated
View File

@@ -90606,7 +90606,7 @@ function isDefaultSetup() {
return isDynamicWorkflow() && !isCCR();
}
function isCCR() {
return isDynamicWorkflow() && process.env["CODEQL_ACTION_ANALYSIS_KEY"]?.startsWith(
return isDynamicWorkflow() && process.env["CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */]?.startsWith(
"dynamic/copilot-pull-request-reviewer"
) || false;
}
@@ -90876,7 +90876,7 @@ async function getWorkflowRelativePath() {
return workflowResponse.data.path;
}
async function getAnalysisKey() {
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY";
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */;
let analysisKey = process.env[analysisKeyEnvVar];
if (analysisKey !== void 0) {
return analysisKey;

2
lib/autobuild-action.js generated
View File

@@ -87542,7 +87542,7 @@ async function getWorkflowRelativePath() {
return workflowResponse.data.path;
}
async function getAnalysisKey() {
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY";
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */;
let analysisKey = process.env[analysisKeyEnvVar];
if (analysisKey !== void 0) {
return analysisKey;

4
lib/init-action-post.js generated
View File

@@ -126724,7 +126724,7 @@ function isDefaultSetup() {
return isDynamicWorkflow() && !isCCR();
}
function isCCR() {
return isDynamicWorkflow() && process.env["CODEQL_ACTION_ANALYSIS_KEY"]?.startsWith(
return isDynamicWorkflow() && process.env["CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */]?.startsWith(
"dynamic/copilot-pull-request-reviewer"
) || false;
}
@@ -126928,7 +126928,7 @@ async function getWorkflowRelativePath() {
return workflowResponse.data.path;
}
async function getAnalysisKey() {
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY";
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */;
let analysisKey = process.env[analysisKeyEnvVar];
if (analysisKey !== void 0) {
return analysisKey;

4
lib/init-action.js generated
View File

@@ -87955,7 +87955,7 @@ function isDefaultSetup() {
return isDynamicWorkflow() && !isCCR();
}
function isCCR() {
return isDynamicWorkflow() && process.env["CODEQL_ACTION_ANALYSIS_KEY"]?.startsWith(
return isDynamicWorkflow() && process.env["CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */]?.startsWith(
"dynamic/copilot-pull-request-reviewer"
) || false;
}
@@ -88206,7 +88206,7 @@ async function getWorkflowRelativePath() {
return workflowResponse.data.path;
}
async function getAnalysisKey() {
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY";
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */;
let analysisKey = process.env[analysisKeyEnvVar];
if (analysisKey !== void 0) {
return analysisKey;

2
lib/resolve-environment-action.js generated
View File

@@ -87550,7 +87550,7 @@ async function getWorkflowRelativePath() {
return workflowResponse.data.path;
}
async function getAnalysisKey() {
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY";
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */;
let analysisKey = process.env[analysisKeyEnvVar];
if (analysisKey !== void 0) {
return analysisKey;

2
lib/setup-codeql-action.js generated
View File

@@ -87667,7 +87667,7 @@ async function getWorkflowRelativePath() {
return workflowResponse.data.path;
}
async function getAnalysisKey() {
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY";
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */;
let analysisKey = process.env[analysisKeyEnvVar];
if (analysisKey !== void 0) {
return analysisKey;

2
lib/start-proxy-action.js generated
View File

@@ -104587,7 +104587,7 @@ async function getWorkflowRelativePath() {
return workflowResponse.data.path;
}
async function getAnalysisKey() {
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY";
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */;
let analysisKey = process.env[analysisKeyEnvVar];
if (analysisKey !== void 0) {
return analysisKey;

4
lib/upload-lib.js generated
View File

@@ -90306,7 +90306,7 @@ function isDefaultSetup() {
return isDynamicWorkflow() && !isCCR();
}
function isCCR() {
return isDynamicWorkflow() && process.env["CODEQL_ACTION_ANALYSIS_KEY"]?.startsWith(
return isDynamicWorkflow() && process.env["CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */]?.startsWith(
"dynamic/copilot-pull-request-reviewer"
) || false;
}
@@ -90528,7 +90528,7 @@ async function getWorkflowRelativePath() {
return workflowResponse.data.path;
}
async function getAnalysisKey() {
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY";
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */;
let analysisKey = process.env[analysisKeyEnvVar];
if (analysisKey !== void 0) {
return analysisKey;

4
lib/upload-sarif-action.js generated
View File

@@ -90337,7 +90337,7 @@ function isDefaultSetup() {
return isDynamicWorkflow() && !isCCR();
}
function isCCR() {
return isDynamicWorkflow() && process.env["CODEQL_ACTION_ANALYSIS_KEY"]?.startsWith(
return isDynamicWorkflow() && process.env["CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */]?.startsWith(
"dynamic/copilot-pull-request-reviewer"
) || false;
}
@@ -90574,7 +90574,7 @@ async function getWorkflowRelativePath() {
return workflowResponse.data.path;
}
async function getAnalysisKey() {
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY";
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY" /* ANALYSIS_KEY */;
let analysisKey = process.env[analysisKeyEnvVar];
if (analysisKey !== void 0) {
return analysisKey;

5
src/actions-util.test.ts
View File

@@ -259,15 +259,14 @@ test("isDynamicWorkflow() returns true if event name is `dynamic`", (t) => {
test("isCCR() returns true when expected", (t) => {
process.env.GITHUB_EVENT_NAME = "dynamic";
process.env.CODEQL_ACTION_ANALYSIS_KEY =
"dynamic/copilot-pull-request-reviewer";
process.env[EnvVar.ANALYSIS_KEY] = "dynamic/copilot-pull-request-reviewer";
t.assert(isCCR());
t.false(isDefaultSetup());
});
test("isDefaultSetup() returns true when expected", (t) => {
process.env.GITHUB_EVENT_NAME = "dynamic";
process.env.CODEQL_ACTION_ANALYSIS_KEY = "dynamic/github-code-scanning";
process.env[EnvVar.ANALYSIS_KEY] = "dynamic/github-code-scanning";
t.assert(isDefaultSetup());
t.false(isCCR());
});

3
src/actions-util.ts
View File

@@ -8,6 +8,7 @@ import * as io from "@actions/io";
import { JSONSchemaForNPMPackageJsonFiles } from "@schemastore/package";
import type { Config } from "./config-utils";
import { EnvVar } from "./environment";
import { Logger } from "./logging";
import {
doesDirectoryExist,
@@ -261,7 +262,7 @@ export function isDefaultSetup(): boolean {
export function isCCR(): boolean {
return (
(isDynamicWorkflow() &&
process.env["CODEQL_ACTION_ANALYSIS_KEY"]?.startsWith(
process.env[EnvVar.ANALYSIS_KEY]?.startsWith(
"dynamic/copilot-pull-request-reviewer",
)) ||
false

3
src/api-client.ts
View File

@@ -3,6 +3,7 @@ import * as githubUtils from "@actions/github/lib/utils";
import * as retry from "@octokit/plugin-retry";
import { getActionVersion, getRequiredInput } from "./actions-util";
import { EnvVar } from "./environment";
import { Logger } from "./logging";
import { getRepositoryNwo, RepositoryNwo } from "./repository";
import {
@@ -189,7 +190,7 @@ export async function getWorkflowRelativePath(): Promise<string> {
* the GitHub API, but after that the result will be cached.
*/
export async function getAnalysisKey(): Promise<string> {
const analysisKeyEnvVar = "CODEQL_ACTION_ANALYSIS_KEY";
const analysisKeyEnvVar = EnvVar.ANALYSIS_KEY;
let analysisKey = process.env[analysisKeyEnvVar];
if (analysisKey !== undefined) {

6
src/environment.ts
View File

@@ -135,4 +135,10 @@ export enum EnvVar {
* Intended for use in environments where git may not be installed, such as Docker containers.
*/
TOLERATE_MISSING_GIT_VERSION = "CODEQL_ACTION_TOLERATE_MISSING_GIT_VERSION",
/**
* Used to store the analysis key used by the CodeQL Action. This is normally populated by
* `getAnalysisKey`, but can also be set manually for testing and non-standard applications.
*/
ANALYSIS_KEY = "CODEQL_ACTION_ANALYSIS_KEY",
}

2
src/status-report.test.ts
View File

@@ -27,7 +27,7 @@ setupTests(test);
function setupEnvironmentAndStub(tmpDir: string) {
setupActionsVars(tmpDir, tmpDir);
process.env["CODEQL_ACTION_ANALYSIS_KEY"] = "analysis-key";
process.env[EnvVar.ANALYSIS_KEY] = "analysis-key";
process.env["GITHUB_EVENT_NAME"] = "dynamic";
process.env["GITHUB_REF"] = "refs/heads/main";
process.env["GITHUB_REPOSITORY"] = "octocat/HelloWorld";