robojerk/codeql-action

Redefine shouldPerformDiffInformedAnalysis()

Browse source 
This commit renames the original shouldPerformDiffInformedAnalysis(),
which returns `PullRequestBranches | undefined`, to
getDiffInformedAnalysisBranches(). It also adds a new
shouldPerformDiffInformedAnalysis() function that returns boolean.

Separating these two functions makes it clear what the intended uses and
return values should be for each.
This commit is contained in:
Chuan-kai Lin 2025-03-28 12:26:26 -07:00
parent 71ab101d38
commit e7f67e2e61
2 changed files with 17 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/analyze-action.ts
View file

@ -22,7 +22,7 @@ import { getCodeQL } from "./codeql";
import { Config, getConfig } from "./config-utils";
import { uploadDatabases } from "./database-upload";
import { uploadDependencyCaches } from "./dependency-caching";
import { shouldPerformDiffInformedAnalysis } from "./diff-informed-analysis-utils";
import { getDiffInformedAnalysisBranches } from "./diff-informed-analysis-utils";
import { EnvVar } from "./environment";
import { Features } from "./feature-flags";
import { Language } from "./languages";
@ -270,7 +270,7 @@ async function run() {
logger,
);
const branches = await shouldPerformDiffInformedAnalysis(
const branches = await getDiffInformedAnalysisBranches(
codeql,
features,
logger,

16
src/diff-informed-analysis-utils.ts
View file

@ -42,12 +42,26 @@ function getPullRequestBranches(): PullRequestBranches | undefined {
/**
* Check if the action should perform diff-informed analysis.
*/
export async function shouldPerformDiffInformedAnalysis(
codeql: CodeQL,
features: FeatureEnablement,
logger: Logger,
): Promise<boolean> {
return (
(await getDiffInformedAnalysisBranches(codeql, features, logger)) !==
undefined
);
}
/**
* Get the branches to use for diff-informed analysis.
*
* @returns If the action should perform diff-informed analysis, return
* the base and head branches that should be used to compute the diff ranges.
* Otherwise return `undefined`.
*/
export async function shouldPerformDiffInformedAnalysis(
export async function getDiffInformedAnalysisBranches(
codeql: CodeQL,
features: FeatureEnablement,
logger: Logger,