Skip to content

Commit fd9b9ba

Browse files
committed
Reduce Config requirements for tryUploadSarifIfRunFailed
1 parent c43f2dc commit fd9b9ba

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,
@@ -87,6 +88,11 @@ interface FailedSarifInfo {
8788
checkoutPath: string;
8889
}
8990

91+
/** The minimal Action configuration required to prepare and upload a failed SARIF. */
92+
export type FailedSarifConfig = ActionConfig<
93+
"codeQLCmd" | "tempDir" | "analysisKinds" | "languages"
94+
>;
95+
9096
/**
9197
* Tries to prepare a SARIF file that contains information about a failed analysis.
9298
*
@@ -95,7 +101,7 @@ interface FailedSarifInfo {
95101
async function prepareFailedSarif(
96102
logger: Logger,
97103
features: FeatureEnablement,
98-
config: Config,
104+
config: FailedSarifConfig,
99105
): Promise<Result<FailedSarifInfo, UploadFailedSarifResult>> {
100106
if (!config.codeQLCmd) {
101107
return new Failure({
@@ -161,7 +167,7 @@ async function prepareFailedSarif(
161167
async function generateFailedSarif(
162168
logger: Logger,
163169
features: FeatureEnablement,
164-
config: Config,
170+
config: ActionConfig<"codeQLCmd" | "tempDir">,
165171
category: string | undefined,
166172
checkoutPath: string,
167173
sarifFile?: string,
@@ -210,7 +216,7 @@ async function generateFailedSarif(
210216
* category for the workflow.
211217
*/
212218
async function maybeUploadFailedSarif(
213-
config: Config,
219+
config: FailedSarifConfig,
214220
repositoryNwo: RepositoryNwo,
215221
features: FeatureEnablement,
216222
logger: Logger,
@@ -245,7 +251,7 @@ async function maybeUploadFailedSarif(
245251

246252
/** Uploads a failed SARIF file as workflow artifact, if it can be generated. */
247253
async function maybeUploadFailedSarifArtifact(
248-
config: Config,
254+
config: FailedSarifConfig,
249255
features: FeatureEnablement,
250256
logger: Logger,
251257
): Promise<UploadFailedSarifResult> {
@@ -285,7 +291,7 @@ async function maybeUploadFailedSarifArtifact(
285291
* @returns The results of uploading the SARIF file for the failure.
286292
*/
287293
export async function tryUploadSarifIfRunFailed(
288-
config: Config,
294+
config: FailedSarifConfig,
289295
repositoryNwo: RepositoryNwo,
290296
features: FeatureEnablement,
291297
logger: Logger,

0 commit comments

Comments
 (0)