github/codeql-action
1
0
Fork 0
mirror of https://github.com/github/codeql-action.git synced 2026-11-11 15:25:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove augmentationProperties variable from initConfig and improve documentation

Browse Source
This commit is contained in:
Michael B. Gale
2025-09-01 15:11:34 +01:00
parent 74064af287
commit 53c72c5dc6
2 changed files with 15 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
lib/init-action.js generated
View File

@@ -90126,7 +90126,6 @@ async function initConfig(inputs) {
);
}
const config = await getDefaultConfig(inputs);
const augmentationProperties = config.augmentationProperties;
config.originalUserInput = userConfig;
const { overlayDatabaseMode, useOverlayDatabaseCaching } = await getOverlayDatabaseMode(
inputs.codeql,
@@ -90135,20 +90134,20 @@ async function initConfig(inputs) {
config.languages,
inputs.sourceRoot,
config.buildMode,
generateCodeScanningConfig(userConfig, augmentationProperties),
generateCodeScanningConfig(userConfig, config.augmentationProperties),
logger
);
logger.info(
`Using overlay database mode: ${overlayDatabaseMode} ${useOverlayDatabaseCaching ? "with" : "without"} caching.`
);
augmentationProperties.overlayDatabaseMode = overlayDatabaseMode;
augmentationProperties.useOverlayDatabaseCaching = useOverlayDatabaseCaching;
config.augmentationProperties.overlayDatabaseMode = overlayDatabaseMode;
config.augmentationProperties.useOverlayDatabaseCaching = useOverlayDatabaseCaching;
if (overlayDatabaseMode === "overlay" /* Overlay */ || await shouldPerformDiffInformedAnalysis(
inputs.codeql,
inputs.features,
logger
)) {
augmentationProperties.extraQueryExclusions.push({
config.augmentationProperties.extraQueryExclusions.push({
exclude: { tags: "exclude-from-incremental" }
});
}

17
src/config-utils.ts
View File

@@ -1103,8 +1103,11 @@ export async function initConfig(inputs: InitConfigInputs): Promise<Config> {
);
}
// Construct a `Config` from the inputs to the action.
// This does not consider the `UserConfig` (if any).
const config = await getDefaultConfig(inputs);
const augmentationProperties = config.augmentationProperties;
// Store the `UserConfig` (if any) in the `Config`.
config.originalUserInput = userConfig;
// The choice of overlay database mode depends on the selection of languages
@@ -1119,15 +1122,16 @@ export async function initConfig(inputs: InitConfigInputs): Promise<Config> {
config.languages,
inputs.sourceRoot,
config.buildMode,
generateCodeScanningConfig(userConfig, augmentationProperties),
generateCodeScanningConfig(userConfig, config.augmentationProperties),
logger,
);
logger.info(
`Using overlay database mode: ${overlayDatabaseMode} ` +
`${useOverlayDatabaseCaching ? "with" : "without"} caching.`,
);
augmentationProperties.overlayDatabaseMode = overlayDatabaseMode;
augmentationProperties.useOverlayDatabaseCaching = useOverlayDatabaseCaching;
config.augmentationProperties.overlayDatabaseMode = overlayDatabaseMode;
config.augmentationProperties.useOverlayDatabaseCaching =
useOverlayDatabaseCaching;
if (
overlayDatabaseMode === OverlayDatabaseMode.Overlay ||
@@ -1137,7 +1141,7 @@ export async function initConfig(inputs: InitConfigInputs): Promise<Config> {
logger,
))
) {
augmentationProperties.extraQueryExclusions.push({
config.augmentationProperties.extraQueryExclusions.push({
exclude: { tags: "exclude-from-incremental" },
});
}
@@ -1424,7 +1428,8 @@ export function generateCodeScanningConfig(
originalUserInput: UserConfig,
augmentationProperties: AugmentationProperties,
): UserConfig {
// make a copy so we can modify it
// Make a copy of the `UserConfig` so we can modify it without mutating
// the original input.
const augmentedConfig = cloneObject(originalUserInput);
// Inject the queries from the input