@@ -7,6 +7,7 @@ import * as actionsUtil from "./actions-util";
77import { CodeScanning , RiskAssessment } from "./analyses" ;
88import { getApiClient , getGitHubVersion } from "./api-client" ;
99import { CodeQL , getCodeQL } from "./codeql" ;
10+ import type { ActionConfig } from "./config/action-config" ;
1011import {
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 {
95101async 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(
161167async 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 */
212218async 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. */
247253async 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 */
287293export async function tryUploadSarifIfRunFailed (
288- config : Config ,
294+ config : FailedSarifConfig ,
289295 repositoryNwo : RepositoryNwo ,
290296 features : FeatureEnablement ,
291297 logger : Logger ,
0 commit comments