@@ -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 ,
@@ -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 {
94100async 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(
160166async 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 */
194200async 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. */
229235async 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 */
269275export async function tryUploadSarifIfRunFailed (
270- config : Config ,
276+ config : FailedSarifConfig ,
271277 repositoryNwo : RepositoryNwo ,
272278 features : FeatureEnablement ,
273279 logger : Logger ,
0 commit comments