github/codeql-action
1
0
Fork 0
mirror of https://github.com/github/codeql-action.git synced 2026-11-05 04:29:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename FF to include "Abort" instead of "Skip"

Browse Source
This commit is contained in:
Michael B. Gale
2026-10-30 11:00:42 +00:00
parent b2bb71bc61
commit 5bdb913da1
6 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/__unsupported-macos.yml generated vendored
View File

@@ -74,7 +74,7 @@ jobs:
continue-on-error: true
env:
CODEQL_ACTION_CHECK_UNSUPPORTED_TRACED_ANALYSIS: true
CODEQL_ACTION_SKIP_UNSUPPORTED_TRACED_ANALYSIS: true
CODEQL_ACTION_ABORT_UNSUPPORTED_TRACED_ANALYSIS: true
with:
languages: swift
tools: ${{ steps.prepare-test.outputs.tools-url }}

18
lib/entry-points.js generated
View File

@@ -179947,9 +179947,9 @@ var featureConfig = {
envVar: "CODEQL_ACTION_START_PROXY_USE_FEATURES_RELEASE",
minimumVersion: void 0
},
["skip_unsupported_traced_analysis" /* SkipUnsupportedTracedAnalysis */]: {
["abort_unsupported_traced_analysis" /* AbortUnsupportedTracedAnalysis */]: {
defaultValue: false,
envVar: "CODEQL_ACTION_SKIP_UNSUPPORTED_TRACED_ANALYSIS",
envVar: "CODEQL_ACTION_ABORT_UNSUPPORTED_TRACED_ANALYSIS",
minimumVersion: void 0
},
["tools_repository_property" /* ToolsRepositoryProperty */]: {
@@ -193924,7 +193924,7 @@ async function checkSwiftCompatibility(config, codeql, darwinVersion2) {
// src/languages/traced.ts
var UNSUPPORTED_DARWIN_FOR_TRACED = 27;
var UNSUPPORTED_XCODE_FOR_TRACED = 27;
function handleUnsupportedVersion(logger2, config, tracedLanguages, skipUnsupportedTracedAnalysis, product, version) {
function handleUnsupportedVersion(logger2, config, tracedLanguages, abortUnsupportedTracedAnalysis, product, version) {
const baseMessage = [
`Traced analysis is not supported on ${product} ${UNSUPPORTED_DARWIN_FOR_TRACED} or above.`,
`Configure your analysis to run on macOS ${UNSUPPORTED_DARWIN_FOR_TRACED - 1} or below`,
@@ -193947,7 +193947,7 @@ function handleUnsupportedVersion(logger2, config, tracedLanguages, skipUnsuppor
baseMessage,
`For more information, see [this announcement](${"https://github.blog/changelog/2026-10-19-codeql-changes-for-macos-27-xcode-27-and-swift-6-4/" /* UNSUPPORTED_TRACED_ANALYSIS_MACOS27 */}).`
].join(" "),
severity: skipUnsupportedTracedAnalysis ? "error" : "warning",
severity: abortUnsupportedTracedAnalysis ? "error" : "warning",
visibility: {
cliSummaryTable: true,
statusPage: true,
@@ -193961,7 +193961,7 @@ function handleUnsupportedVersion(logger2, config, tracedLanguages, skipUnsuppor
baseMessage,
`For more information, see ${"https://github.blog/changelog/2026-10-19-codeql-changes-for-macos-27-xcode-27-and-swift-6-4/" /* UNSUPPORTED_TRACED_ANALYSIS_MACOS27 */}`
].join(" ");
if (skipUnsupportedTracedAnalysis) {
if (abortUnsupportedTracedAnalysis) {
throw new ConfigurationError(logMessage);
} else {
logger2.warning(logMessage);
@@ -194004,8 +194004,8 @@ async function checkRunnerSupportsTracedAnalysis(action, config, codeql) {
);
return;
}
const skipUnsupportedTracedAnalysis = await action.features.getValue(
"skip_unsupported_traced_analysis" /* SkipUnsupportedTracedAnalysis */
const abortUnsupportedTracedAnalysis = await action.features.getValue(
"abort_unsupported_traced_analysis" /* AbortUnsupportedTracedAnalysis */
);
if (typeof version === "string") {
action.logger.warning(
@@ -194016,7 +194016,7 @@ async function checkRunnerSupportsTracedAnalysis(action, config, codeql) {
action.logger,
config,
tracedLanguages,
skipUnsupportedTracedAnalysis,
abortUnsupportedTracedAnalysis,
"macOS",
version
);
@@ -194034,7 +194034,7 @@ async function checkRunnerSupportsTracedAnalysis(action, config, codeql) {
action.logger,
config,
tracedLanguages,
skipUnsupportedTracedAnalysis,
abortUnsupportedTracedAnalysis,
"Xcode",
xcodeVer
);

2
pr-checks/checks/unsupported-macos.yml
View File

@@ -28,7 +28,7 @@ steps:
continue-on-error: true
env:
CODEQL_ACTION_CHECK_UNSUPPORTED_TRACED_ANALYSIS: true
CODEQL_ACTION_SKIP_UNSUPPORTED_TRACED_ANALYSIS: true
CODEQL_ACTION_ABORT_UNSUPPORTED_TRACED_ANALYSIS: true
with:
languages: swift
tools: ${{ steps.prepare-test.outputs.tools-url }}

6
src/feature-flags.ts
View File

@@ -150,7 +150,7 @@ export enum Feature {
OverlayAnalysisStatusSave = "overlay_analysis_status_save",
QaTelemetryEnabled = "qa_telemetry_enabled",
/** Whether we should fail early if we detect that traced analysis is unsupported. */
SkipUnsupportedTracedAnalysis = "skip_unsupported_traced_analysis",
AbortUnsupportedTracedAnalysis = "abort_unsupported_traced_analysis",
/** Routes (some) API requests through the registry proxy. */
ProxyApiRequests = "proxy_api_requests",
/** Note that this currently only disables baseline file coverage information. */
@@ -422,9 +422,9 @@ export const featureConfig = {
envVar: "CODEQL_ACTION_START_PROXY_USE_FEATURES_RELEASE",
minimumVersion: undefined,
},
[Feature.SkipUnsupportedTracedAnalysis]: {
[Feature.AbortUnsupportedTracedAnalysis]: {
defaultValue: false,
envVar: "CODEQL_ACTION_SKIP_UNSUPPORTED_TRACED_ANALYSIS",
envVar: "CODEQL_ACTION_ABORT_UNSUPPORTED_TRACED_ANALYSIS",
minimumVersion: undefined,
},
[Feature.ToolsRepositoryProperty]: {

4
src/languages/traced.test.ts
View File

@@ -278,7 +278,7 @@ test.serial(
const features = createFeatures([
Feature.CheckUnsupportedTracedAnalysis,
Feature.SkipUnsupportedTracedAnalysis,
Feature.AbortUnsupportedTracedAnalysis,
]);
const codeql = await getCodeQLWithTracedStub(
@@ -518,7 +518,7 @@ test.serial(
const features = createFeatures([
Feature.CheckUnsupportedTracedAnalysis,
Feature.SkipUnsupportedTracedAnalysis,
Feature.AbortUnsupportedTracedAnalysis,
]);
const codeql = await getCodeQLWithTracedStub(

16
src/languages/traced.ts
View File

@@ -26,7 +26,7 @@ export const UNSUPPORTED_XCODE_FOR_TRACED = 27;
* @param logger The logger to use.
* @param config The CodeQL Action configuration.
* @param tracedLanguages Traced languages that are configured for analysis.
* @param skipUnsupportedTracedAnalysis Whether this is a fatal error.
* @param abortUnsupportedTracedAnalysis Whether this is a fatal error.
* @param product The product that the version is unsupported of.
* @param version The unsupported version.
*/
@@ -34,7 +34,7 @@ function handleUnsupportedVersion(
logger: Logger,
config: ActionConfig<"dbLocation" | "tempDir">,
tracedLanguages: string[],
skipUnsupportedTracedAnalysis: boolean,
abortUnsupportedTracedAnalysis: boolean,
product: "macOS" | "Xcode",
version: semver.SemVer,
) {
@@ -63,7 +63,7 @@ function handleUnsupportedVersion(
baseMessage,
`For more information, see [this announcement](${DocUrl.UNSUPPORTED_TRACED_ANALYSIS_MACOS27}).`,
].join(" "),
severity: skipUnsupportedTracedAnalysis ? "error" : "warning",
severity: abortUnsupportedTracedAnalysis ? "error" : "warning",
visibility: {
cliSummaryTable: true,
statusPage: true,
@@ -81,7 +81,7 @@ function handleUnsupportedVersion(
].join(" ");
// Throw an error to abort the analysis if the FF is enabled or log the message.
if (skipUnsupportedTracedAnalysis) {
if (abortUnsupportedTracedAnalysis) {
throw new ConfigurationError(logMessage);
} else {
// This will also show up as a workflow annotation.
@@ -159,8 +159,8 @@ export async function checkRunnerSupportsTracedAnalysis(
return;
}
const skipUnsupportedTracedAnalysis = await action.features.getValue(
Feature.SkipUnsupportedTracedAnalysis,
const abortUnsupportedTracedAnalysis = await action.features.getValue(
Feature.AbortUnsupportedTracedAnalysis,
);
if (typeof version === "string") {
// If we got a string, we are on macOS but couldn't parse the version string.
@@ -172,7 +172,7 @@ export async function checkRunnerSupportsTracedAnalysis(
action.logger,
config,
tracedLanguages,
skipUnsupportedTracedAnalysis,
abortUnsupportedTracedAnalysis,
"macOS",
version,
);
@@ -203,7 +203,7 @@ export async function checkRunnerSupportsTracedAnalysis(
action.logger,
config,
tracedLanguages,
skipUnsupportedTracedAnalysis,
abortUnsupportedTracedAnalysis,
"Xcode",
xcodeVer,
);