github/codeql-action
0
0
Fork 0
mirror of https://github.com/github/codeql-action.git synced 2026-05-09 15:20:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add env var to enable file coverage on PRs

Browse Source
This commit is contained in:
Henry Mercer
2026-03-02 19:55:35 +01:00
parent 003c59c557
commit 2a4d1eca6b
6 changed files with 119 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/analyze-action.js
Generated
+8 -1
View File
@@ -110807,7 +110807,14 @@ async function runQueries(sarifFolder, memoryFlag, threadsFlag, diffRangePackDir
}
if (!config.enableFileCoverageInformation) {
const isOrgOwned = github2.context.payload.repository?.owner.type === "Organization";
const reenableMessage = isOrgOwned ? ` To enable file coverage information on pull requests, set the '${"github-codeql-enable-file-coverage-on-prs" /* ENABLE_FILE_COVERAGE_ON_PRS */}' repository property to 'true'.` : "";
let reenableMessage;
if (isOrgOwned) {
reenableMessage = ` To enable file coverage information on pull requests, set the '${"github-codeql-enable-file-coverage-on-prs" /* ENABLE_FILE_COVERAGE_ON_PRS */}' repository property to 'true'.`;
} else if (!isDefaultSetup()) {
reenableMessage = ` To enable file coverage information on pull requests, set the '${"CODEQL_ACTION_ENABLE_FILE_COVERAGE_ON_PRS" /* ENABLE_FILE_COVERAGE_ON_PRS */}' environment variable to 'true'.`;
} else {
reenableMessage = "";
}
logger.info(
`To speed up pull request analysis, file coverage information is only enabled when analyzing the default branch and protected branches.${reenableMessage}`
);
lib/init-action.js
Generated
+7 -1
View File
@@ -109056,9 +109056,15 @@ function cleanupDatabaseClusterDirectory(config, logger, options = {}, rmSync2 =
async function getFileCoverageInformationEnabled(debugMode, repositoryNwo, features, repositoryProperties, logger) {
if (debugMode) return true;
if (!isAnalyzingPullRequest()) return true;
if (process.env["CODEQL_ACTION_ENABLE_FILE_COVERAGE_ON_PRS" /* ENABLE_FILE_COVERAGE_ON_PRS */] === "true") {
logger.info(
`File coverage information on pull requests has been enabled by the '${"CODEQL_ACTION_ENABLE_FILE_COVERAGE_ON_PRS" /* ENABLE_FILE_COVERAGE_ON_PRS */}' environment variable. This may increase the time it takes to analyze pull requests, particularly on large repositories.`
);
return true;
}
if (repositoryProperties["github-codeql-enable-file-coverage-on-prs" /* ENABLE_FILE_COVERAGE_ON_PRS */] === true) {
logger.info(
`File coverage information on pull requests has been enabled by the '${"github-codeql-enable-file-coverage-on-prs" /* ENABLE_FILE_COVERAGE_ON_PRS */}' repository property. This will increase the time it takes to analyze pull requests, particularly on large repositories.`
`File coverage information on pull requests has been enabled by the '${"github-codeql-enable-file-coverage-on-prs" /* ENABLE_FILE_COVERAGE_ON_PRS */}' repository property. This may increase the time it takes to analyze pull requests, particularly on large repositories.`
);
return true;
}
src/analyze.ts
+13 -4
View File
@@ -6,7 +6,11 @@ import * as github from "@actions/github";
import * as io from "@actions/io";
import * as yaml from "js-yaml";
import { getTemporaryDirectory, PullRequestBranches } from "./actions-util";
import {
getTemporaryDirectory,
isDefaultSetup,
PullRequestBranches,
} from "./actions-util";
import * as analyses from "./analyses";
import { setupCppAutobuild } from "./autobuild";
import { type CodeQL } from "./codeql";
@@ -506,9 +510,14 @@ export async function runQueries(
if (!config.enableFileCoverageInformation) {
const isOrgOwned =
github.context.payload.repository?.owner.type === "Organization";
const reenableMessage = isOrgOwned
? ` To enable file coverage information on pull requests, set the '${RepositoryPropertyName.ENABLE_FILE_COVERAGE_ON_PRS}' repository property to 'true'.`
: "";
let reenableMessage: string;
if (isOrgOwned) {
reenableMessage = ` To enable file coverage information on pull requests, set the '${RepositoryPropertyName.ENABLE_FILE_COVERAGE_ON_PRS}' repository property to 'true'.`;
} else if (!isDefaultSetup()) {
reenableMessage = ` To enable file coverage information on pull requests, set the '${EnvVar.ENABLE_FILE_COVERAGE_ON_PRS}' environment variable to 'true'.`;
} else {
reenableMessage = "";
}
logger.info(
`To speed up pull request analysis, file coverage information is only enabled when analyzing the default branch and protected branches.${reenableMessage}`,
);
src/environment.ts
+5
View File
@@ -142,6 +142,11 @@ export enum EnvVar {
*/
ANALYSIS_KEY = "CODEQL_ACTION_ANALYSIS_KEY",
/**
* Whether to enable file coverage information on pull requests.
*/
ENABLE_FILE_COVERAGE_ON_PRS = "CODEQL_ACTION_ENABLE_FILE_COVERAGE_ON_PRS",
/** Used by Code Scanning Risk Assessment to communicate the assessment ID to the CodeQL Action. */
RISK_ASSESSMENT_ID = "CODEQL_ACTION_RISK_ASSESSMENT_ID",
}
src/init.test.ts
+72
View File
@@ -6,6 +6,7 @@ import * as sinon from "sinon";
import * as actionsUtil from "./actions-util";
import { createStubCodeQL } from "./codeql";
import { EnvVar } from "./environment";
import { Feature } from "./feature-flags";
import { RepositoryPropertyName } from "./feature-flags/properties";
import {
@@ -546,3 +547,74 @@ test("file coverage information enabled when repository property enables it on P
),
);
});
test("file coverage information enabled when env var enables it on PRs", async (t) => {
sinon.stub(actionsUtil, "isAnalyzingPullRequest").returns(true);
process.env[EnvVar.ENABLE_FILE_COVERAGE_ON_PRS] = "true";
t.teardown(() => {
delete process.env[EnvVar.ENABLE_FILE_COVERAGE_ON_PRS];
});
const messages: LoggedMessage[] = [];
const logger = getRecordingLogger(messages);
t.true(
await getFileCoverageInformationEnabled(
false, // debugMode
parseRepositoryNwo("github/codeql-action"),
createFeatures([Feature.SkipFileCoverageOnPrs]),
{},
logger,
),
);
t.true(
messages.some(
(m) =>
m.type === "info" &&
typeof m.message === "string" &&
m.message.includes(EnvVar.ENABLE_FILE_COVERAGE_ON_PRS),
),
);
});
test("file coverage env var takes precedence over repository property", async (t) => {
sinon.stub(actionsUtil, "isAnalyzingPullRequest").returns(true);
process.env[EnvVar.ENABLE_FILE_COVERAGE_ON_PRS] = "true";
t.teardown(() => {
delete process.env[EnvVar.ENABLE_FILE_COVERAGE_ON_PRS];
});
const messages: LoggedMessage[] = [];
const logger = getRecordingLogger(messages);
t.true(
await getFileCoverageInformationEnabled(
false, // debugMode
parseRepositoryNwo("github/codeql-action"),
createFeatures([Feature.SkipFileCoverageOnPrs]),
{
[RepositoryPropertyName.ENABLE_FILE_COVERAGE_ON_PRS]: true,
},
logger,
),
);
// Should mention the env var, not the repo property
t.true(
messages.some(
(m) =>
m.type === "info" &&
typeof m.message === "string" &&
m.message.includes(EnvVar.ENABLE_FILE_COVERAGE_ON_PRS),
),
);
t.false(
messages.some(
(m) =>
m.type === "info" &&
typeof m.message === "string" &&
m.message.includes(RepositoryPropertyName.ENABLE_FILE_COVERAGE_ON_PRS),
),
);
});
src/init.ts
+14 -2
View File
@@ -13,6 +13,7 @@ import {
import { GitHubApiDetails } from "./api-client";
import { CodeQL, setupCodeQL } from "./codeql";
import * as configUtils from "./config-utils";
import { EnvVar } from "./environment";
import {
CodeQLDefaultVersionInfo,
Feature,
@@ -317,6 +318,17 @@ export async function getFileCoverageInformationEnabled(
// it is used to populate the status page.
if (!isAnalyzingPullRequest()) return true;
// Allow users to opt in to file coverage on PRs via an environment variable.
if (process.env[EnvVar.ENABLE_FILE_COVERAGE_ON_PRS] === "true") {
logger.info(
"File coverage information on pull requests has been enabled by the " +
`'${EnvVar.ENABLE_FILE_COVERAGE_ON_PRS}' environment variable. ` +
"This may increase the time it takes to analyze pull requests, " +
"particularly on large repositories.",
);
return true;
}
// Allow repository owners to opt in to file coverage on PRs via a
// repository property.
if (
@@ -326,8 +338,8 @@ export async function getFileCoverageInformationEnabled(
logger.info(
"File coverage information on pull requests has been enabled by the " +
`'${RepositoryPropertyName.ENABLE_FILE_COVERAGE_ON_PRS}' repository property. ` +
"This will increase the time it takes to analyze pull requests, particularly on " +
"large repositories.",
"This may increase the time it takes to analyze pull requests, " +
"particularly on large repositories.",
);
return true;
}