Skip to content

Commit d4e0565

Browse files
committed
Reduce Config requirements for tryUploadSarifIfRunFailed
1 parent 094b464 commit d4e0565

2 files changed

Lines changed: 21 additions & 9 deletions

File tree

‎src/config-utils.ts‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {
2121
import * as api from "./api-client";
2222
import { getCachingKind } from "./caching-utils";
2323
import { type CodeQL } from "./codeql";
24-
import { type Config } from "./config/action-config";
24+
import { type ActionConfig, type Config } from "./config/action-config";
2525
import {
2626
calculateAugmentation,
2727
ExcludeQueryFilter,
@@ -1618,21 +1618,27 @@ export function appendExtraQueryExclusions(
16181618
/**
16191619
* Returns `true` if Code Scanning analysis is enabled, or `false` if not.
16201620
*/
1621-
export function isCodeScanningEnabled(config: Config): boolean {
1621+
export function isCodeScanningEnabled(
1622+
config: ActionConfig<"analysisKinds">,
1623+
): boolean {
16221624
return config.analysisKinds.includes(AnalysisKind.CodeScanning);
16231625
}
16241626

16251627
/**
16261628
* Returns `true` if Code Quality analysis is enabled, or `false` if not.
16271629
*/
1628-
export function isCodeQualityEnabled(config: Config): boolean {
1630+
export function isCodeQualityEnabled(
1631+
config: ActionConfig<"analysisKinds">,
1632+
): boolean {
16291633
return config.analysisKinds.includes(AnalysisKind.CodeQuality);
16301634
}
16311635

16321636
/**
16331637
* Returns `true` if Code Scanning Risk Assessment analysis is enabled, or `false` if not.
16341638
*/
1635-
export function isRiskAssessmentEnabled(config: Config): boolean {
1639+
export function isRiskAssessmentEnabled(
1640+
config: ActionConfig<"analysisKinds">,
1641+
): boolean {
16361642
return config.analysisKinds.includes(AnalysisKind.RiskAssessment);
16371643
}
16381644

‎src/init-action-post-helper.ts‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import * as actionsUtil from "./actions-util";
77
import { CodeScanning, RiskAssessment } from "./analyses";
88
import { getApiClient, getGitHubVersion } from "./api-client";
99
import { CodeQL, getCodeQL } from "./codeql";
10+
import type { ActionConfig } from "./config/action-config";
1011
import {
1112
Config,
1213
isCodeScanningEnabled,
@@ -86,6 +87,11 @@ interface FailedSarifInfo {
8687
checkoutPath: string;
8788
}
8889

90+
/** The minimal Action configuration required to prepare and upload a failed SARIF. */
91+
export type FailedSarifConfig = ActionConfig<
92+
"codeQLCmd" | "tempDir" | "analysisKinds" | "languages"
93+
>;
94+
8995
/**
9096
* Tries to prepare a SARIF file that contains information about a failed analysis.
9197
*
@@ -94,7 +100,7 @@ interface FailedSarifInfo {
94100
async function prepareFailedSarif(
95101
logger: Logger,
96102
features: FeatureEnablement,
97-
config: Config,
103+
config: FailedSarifConfig,
98104
): Promise<Result<FailedSarifInfo, UploadFailedSarifResult>> {
99105
if (!config.codeQLCmd) {
100106
return new Failure({
@@ -160,7 +166,7 @@ async function prepareFailedSarif(
160166
async function generateFailedSarif(
161167
logger: Logger,
162168
features: FeatureEnablement,
163-
config: Config,
169+
config: ActionConfig<"codeQLCmd" | "tempDir">,
164170
category: string | undefined,
165171
checkoutPath: string,
166172
sarifFile?: string,
@@ -192,7 +198,7 @@ async function generateFailedSarif(
192198
* category for the workflow.
193199
*/
194200
async function maybeUploadFailedSarif(
195-
config: Config,
201+
config: FailedSarifConfig,
196202
repositoryNwo: RepositoryNwo,
197203
features: FeatureEnablement,
198204
logger: Logger,
@@ -227,7 +233,7 @@ async function maybeUploadFailedSarif(
227233

228234
/** Uploads a failed SARIF file as workflow artifact, if it can be generated. */
229235
async function maybeUploadFailedSarifArtifact(
230-
config: Config,
236+
config: FailedSarifConfig,
231237
features: FeatureEnablement,
232238
logger: Logger,
233239
): Promise<UploadFailedSarifResult> {
@@ -267,7 +273,7 @@ async function maybeUploadFailedSarifArtifact(
267273
* @returns The results of uploading the SARIF file for the failure.
268274
*/
269275
export async function tryUploadSarifIfRunFailed(
270-
config: Config,
276+
config: FailedSarifConfig,
271277
repositoryNwo: RepositoryNwo,
272278
features: FeatureEnablement,
273279
logger: Logger,

0 commit comments

Comments
 (0)