Skip to content

Commit d6621b9

Browse files
committed
Refactor check whether CQ is enabled
This will make it easier to replace in the future
1 parent 5b49155 commit d6621b9

File tree

9 files changed

+27
-10
lines changed

9 files changed

+27
-10
lines changed

lib/analyze-action.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/analyze-action.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/analyze.js

Lines changed: 3 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/analyze.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/config-utils.js

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/config-utils.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/analyze-action.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { getApiDetails, getGitHubVersion } from "./api-client";
1818
import { runAutobuild } from "./autobuild";
1919
import { getTotalCacheSize, shouldStoreCache } from "./caching-utils";
2020
import { getCodeQL } from "./codeql";
21-
import { Config, getConfig } from "./config-utils";
21+
import { Config, getConfig, isCodeQualityEnabled } from "./config-utils";
2222
import { uploadDatabases } from "./database-upload";
2323
import { uploadDependencyCaches } from "./dependency-caching";
2424
import { getDiffInformedAnalysisBranches } from "./diff-informed-analysis-utils";
@@ -336,7 +336,7 @@ async function run() {
336336
);
337337
core.setOutput("sarif-id", uploadResult.sarifID);
338338

339-
if (config.augmentationProperties.qualityQueriesInput !== undefined) {
339+
if (isCodeQualityEnabled(config)) {
340340
const qualityUploadResult = await uploadLib.uploadFiles(
341341
outputDir,
342342
actionsUtil.getRequiredInput("checkout_path"),

src/analyze.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -662,7 +662,7 @@ export async function runQueries(
662662
const sarifFile = path.join(sarifFolder, `${language}.sarif`);
663663

664664
const queries: string[] = [];
665-
if (config.augmentationProperties.qualityQueriesInput !== undefined) {
665+
if (configUtils.isCodeQualityEnabled(config)) {
666666
queries.push(util.getGeneratedSuitePath(config, language));
667667
for (const qualityQuery of config.augmentationProperties
668668
.qualityQueriesInput) {
@@ -695,7 +695,7 @@ export async function runQueries(
695695
);
696696

697697
let qualityAnalysisSummary: string | undefined;
698-
if (config.augmentationProperties.qualityQueriesInput !== undefined) {
698+
if (configUtils.isCodeQualityEnabled(config)) {
699699
logger.info(`Interpreting quality results for ${language}`);
700700
const qualityCategory = fixCodeQualityCategory(
701701
logger,

src/config-utils.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1468,3 +1468,12 @@ export function generateCodeScanningConfig(
14681468
}
14691469
return augmentedConfig;
14701470
}
1471+
1472+
/**
1473+
* Returns `true` if Code Quality analysis is enabled, or `false` if not.
1474+
*/
1475+
export function isCodeQualityEnabled(config: Config): config is Config & {
1476+
augmentationProperties: { qualityQueriesInput: string };
1477+
} {
1478+
return config.augmentationProperties.qualityQueriesInput !== undefined;
1479+
}

0 commit comments

Comments
 (0)