mirror of
https://github.com/github/codeql-action.git
synced 2025-12-30 03:00:13 +08:00
Stop using the artifact_v4_upgrade feature flag
This commit is contained in:
@@ -10,14 +10,8 @@ import { getGitHubVersion } from "./api-client";
|
||||
import { getConfig } from "./config-utils";
|
||||
import * as debugArtifacts from "./debug-artifacts";
|
||||
import { EnvVar } from "./environment";
|
||||
import { Features } from "./feature-flags";
|
||||
import { getActionsLogger, withGroup } from "./logging";
|
||||
import { parseRepositoryNwo } from "./repository";
|
||||
import {
|
||||
checkGitHubVersionInRange,
|
||||
getErrorMessage,
|
||||
getRequiredEnvParam,
|
||||
} from "./util";
|
||||
import { checkGitHubVersionInRange, getErrorMessage } from "./util";
|
||||
|
||||
async function runWrapper() {
|
||||
try {
|
||||
@@ -25,15 +19,6 @@ async function runWrapper() {
|
||||
const logger = getActionsLogger();
|
||||
const gitHubVersion = await getGitHubVersion();
|
||||
checkGitHubVersionInRange(gitHubVersion, logger);
|
||||
const repositoryNwo = parseRepositoryNwo(
|
||||
getRequiredEnvParam("GITHUB_REPOSITORY"),
|
||||
);
|
||||
const features = new Features(
|
||||
gitHubVersion,
|
||||
repositoryNwo,
|
||||
actionsUtil.getTemporaryDirectory(),
|
||||
logger,
|
||||
);
|
||||
|
||||
// Upload SARIF artifacts if we determine that this is a first-party analysis run.
|
||||
// For third-party runs, this artifact will be uploaded in the `upload-sarif-post` step.
|
||||
@@ -47,7 +32,6 @@ async function runWrapper() {
|
||||
debugArtifacts.uploadCombinedSarifArtifacts(
|
||||
logger,
|
||||
config.gitHubVersion.type,
|
||||
features,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
@@ -1,9 +1,7 @@
|
||||
import test from "ava";
|
||||
|
||||
import * as debugArtifacts from "./debug-artifacts";
|
||||
import { Feature } from "./feature-flags";
|
||||
import { getActionsLogger } from "./logging";
|
||||
import { createFeatures } from "./testing-utils";
|
||||
import { GitHubVariant } from "./util";
|
||||
|
||||
test("sanitizeArtifactName", (t) => {
|
||||
@@ -25,7 +23,6 @@ test("sanitizeArtifactName", (t) => {
|
||||
test("uploadDebugArtifacts", async (t) => {
|
||||
// Test that no error is thrown if artifacts list is empty.
|
||||
const logger = getActionsLogger();
|
||||
const mockFeature = createFeatures([Feature.ArtifactV4Upgrade]);
|
||||
await t.notThrowsAsync(
|
||||
debugArtifacts.uploadDebugArtifacts(
|
||||
logger,
|
||||
@@ -33,7 +30,6 @@ test("uploadDebugArtifacts", async (t) => {
|
||||
"rootDir",
|
||||
"artifactName",
|
||||
GitHubVariant.DOTCOM,
|
||||
mockFeature,
|
||||
),
|
||||
);
|
||||
});
|
||||
|
||||
@@ -12,7 +12,6 @@ import { dbIsFinalized } from "./analyze";
|
||||
import { getCodeQL } from "./codeql";
|
||||
import { Config } from "./config-utils";
|
||||
import { EnvVar } from "./environment";
|
||||
import { Feature, FeatureEnablement } from "./feature-flags";
|
||||
import { Language } from "./languages";
|
||||
import { Logger, withGroup } from "./logging";
|
||||
import {
|
||||
@@ -35,7 +34,6 @@ export function sanitizeArtifactName(name: string): string {
|
||||
export async function uploadCombinedSarifArtifacts(
|
||||
logger: Logger,
|
||||
gitHubVariant: GitHubVariant,
|
||||
features: FeatureEnablement,
|
||||
) {
|
||||
const tempDir = getTemporaryDirectory();
|
||||
|
||||
@@ -70,7 +68,6 @@ export async function uploadCombinedSarifArtifacts(
|
||||
baseTempDir,
|
||||
"combined-sarif-artifacts",
|
||||
gitHubVariant,
|
||||
features,
|
||||
);
|
||||
} catch (e) {
|
||||
logger.warning(
|
||||
@@ -163,7 +160,6 @@ async function tryBundleDatabase(
|
||||
export async function tryUploadAllAvailableDebugArtifacts(
|
||||
config: Config,
|
||||
logger: Logger,
|
||||
features: FeatureEnablement,
|
||||
) {
|
||||
const filesToUpload: string[] = [];
|
||||
try {
|
||||
@@ -227,7 +223,6 @@ export async function tryUploadAllAvailableDebugArtifacts(
|
||||
config.dbLocation,
|
||||
config.debugArtifactName,
|
||||
config.gitHubVersion.type,
|
||||
features,
|
||||
),
|
||||
);
|
||||
} catch (e) {
|
||||
@@ -243,7 +238,6 @@ export async function uploadDebugArtifacts(
|
||||
rootDir: string,
|
||||
artifactName: string,
|
||||
ghVariant: GitHubVariant,
|
||||
features: FeatureEnablement,
|
||||
) {
|
||||
if (toUpload.length === 0) {
|
||||
return;
|
||||
@@ -263,11 +257,7 @@ export async function uploadDebugArtifacts(
|
||||
}
|
||||
}
|
||||
|
||||
const artifactUploader = await getArtifactUploaderClient(
|
||||
logger,
|
||||
ghVariant,
|
||||
features,
|
||||
);
|
||||
const artifactUploader = await getArtifactUploaderClient(logger, ghVariant);
|
||||
|
||||
try {
|
||||
await artifactUploader.uploadArtifact(
|
||||
@@ -292,18 +282,12 @@ export async function uploadDebugArtifacts(
|
||||
export async function getArtifactUploaderClient(
|
||||
logger: Logger,
|
||||
ghVariant: GitHubVariant,
|
||||
features: FeatureEnablement,
|
||||
): Promise<artifact.ArtifactClient | artifactLegacy.ArtifactClient> {
|
||||
if (ghVariant === GitHubVariant.GHES) {
|
||||
logger.info(
|
||||
"Debug artifacts can be consumed with `actions/download-artifact@v3` because the `v4` version is not yet compatible on GHES.",
|
||||
);
|
||||
return artifactLegacy.create();
|
||||
} else if (!(await features.getValue(Feature.ArtifactV4Upgrade))) {
|
||||
logger.info(
|
||||
"Debug artifacts can be consumed with `actions/download-artifact@v3`. To use the `actions/download-artifact@v4`, set the `CODEQL_ACTION_ARTIFACT_V4_UPGRADE` environment variable to true.",
|
||||
);
|
||||
return artifactLegacy.create();
|
||||
} else {
|
||||
logger.info(
|
||||
"Debug artifacts can be consumed with `actions/download-artifact@v4`.",
|
||||
|
||||
@@ -48,7 +48,6 @@ export interface FeatureEnablement {
|
||||
* Legacy features should end with `_enabled`.
|
||||
*/
|
||||
export enum Feature {
|
||||
ArtifactV4Upgrade = "artifact_v4_upgrade",
|
||||
CleanupTrapCaches = "cleanup_trap_caches",
|
||||
CppBuildModeNone = "cpp_build_mode_none",
|
||||
CppDependencyInstallation = "cpp_dependency_installation_enabled",
|
||||
@@ -94,11 +93,6 @@ export const featureConfig: Record<
|
||||
toolsFeature?: ToolsFeature;
|
||||
}
|
||||
> = {
|
||||
[Feature.ArtifactV4Upgrade]: {
|
||||
defaultValue: true,
|
||||
envVar: "CODEQL_ACTION_ARTIFACT_V4_UPGRADE",
|
||||
minimumVersion: undefined,
|
||||
},
|
||||
[Feature.CleanupTrapCaches]: {
|
||||
defaultValue: false,
|
||||
envVar: "CODEQL_ACTION_CLEANUP_TRAP_CACHES",
|
||||
|
||||
@@ -9,14 +9,8 @@ import * as actionsUtil from "./actions-util";
|
||||
import { getGitHubVersion } from "./api-client";
|
||||
import * as configUtils from "./config-utils";
|
||||
import { getArtifactUploaderClient } from "./debug-artifacts";
|
||||
import { Features } from "./feature-flags";
|
||||
import { getActionsLogger } from "./logging";
|
||||
import { parseRepositoryNwo } from "./repository";
|
||||
import {
|
||||
checkGitHubVersionInRange,
|
||||
getErrorMessage,
|
||||
getRequiredEnvParam,
|
||||
} from "./util";
|
||||
import { checkGitHubVersionInRange, getErrorMessage } from "./util";
|
||||
|
||||
async function runWrapper() {
|
||||
try {
|
||||
@@ -51,21 +45,11 @@ async function runWrapper() {
|
||||
const logger = getActionsLogger();
|
||||
const gitHubVersion = await getGitHubVersion();
|
||||
checkGitHubVersionInRange(gitHubVersion, logger);
|
||||
const repositoryNwo = parseRepositoryNwo(
|
||||
getRequiredEnvParam("GITHUB_REPOSITORY"),
|
||||
);
|
||||
const features = new Features(
|
||||
gitHubVersion,
|
||||
repositoryNwo,
|
||||
actionsUtil.getTemporaryDirectory(),
|
||||
logger,
|
||||
);
|
||||
|
||||
try {
|
||||
const artifactUploader = await getArtifactUploaderClient(
|
||||
logger,
|
||||
gitHubVersion.type,
|
||||
features,
|
||||
);
|
||||
|
||||
await artifactUploader.uploadArtifact(
|
||||
|
||||
@@ -6,18 +6,11 @@
|
||||
import * as core from "@actions/core";
|
||||
|
||||
import * as actionsUtil from "./actions-util";
|
||||
import { getTemporaryDirectory } from "./actions-util";
|
||||
import { getGitHubVersion } from "./api-client";
|
||||
import * as debugArtifacts from "./debug-artifacts";
|
||||
import { EnvVar } from "./environment";
|
||||
import { Features } from "./feature-flags";
|
||||
import { getActionsLogger, withGroup } from "./logging";
|
||||
import { parseRepositoryNwo } from "./repository";
|
||||
import {
|
||||
checkGitHubVersionInRange,
|
||||
getErrorMessage,
|
||||
getRequiredEnvParam,
|
||||
} from "./util";
|
||||
import { checkGitHubVersionInRange, getErrorMessage } from "./util";
|
||||
|
||||
async function runWrapper() {
|
||||
try {
|
||||
@@ -26,15 +19,6 @@ async function runWrapper() {
|
||||
const logger = getActionsLogger();
|
||||
const gitHubVersion = await getGitHubVersion();
|
||||
checkGitHubVersionInRange(gitHubVersion, logger);
|
||||
const repositoryNwo = parseRepositoryNwo(
|
||||
getRequiredEnvParam("GITHUB_REPOSITORY"),
|
||||
);
|
||||
const features = new Features(
|
||||
gitHubVersion,
|
||||
repositoryNwo,
|
||||
getTemporaryDirectory(),
|
||||
logger,
|
||||
);
|
||||
|
||||
// Upload SARIF artifacts if we determine that this is a third-party analysis run.
|
||||
// For first-party runs, this artifact will be uploaded in the `analyze-post` step.
|
||||
@@ -46,11 +30,7 @@ async function runWrapper() {
|
||||
return;
|
||||
}
|
||||
await withGroup("Uploading combined SARIF debug artifact", () =>
|
||||
debugArtifacts.uploadCombinedSarifArtifacts(
|
||||
logger,
|
||||
gitHubVersion.type,
|
||||
features,
|
||||
),
|
||||
debugArtifacts.uploadCombinedSarifArtifacts(logger, gitHubVersion.type),
|
||||
);
|
||||
}
|
||||
} catch (error) {
|
||||
|
||||
Reference in New Issue
Block a user