From 14f41bd4214f6e6904562e7a1a221309d92b19b2 Mon Sep 17 00:00:00 2001
From: "Michael B. Gale" <mbg@github.com>
Date: Thu, 28 Aug 2025 16:58:28 +0100
Subject: [PATCH] Add `kind` property to `AnalysisConfig` and documentation

---
 lib/analyze-action.js      | 2 ++
 lib/init-action-post.js    | 2 ++
 lib/upload-lib.js          | 2 ++
 lib/upload-sarif-action.js | 2 ++
 src/analyses.ts            | 9 +++++++++
 5 files changed, 17 insertions(+)

diff --git a/lib/analyze-action.js b/lib/analyze-action.js
index 7ac7b679f..d66eb32fd 100644
--- a/lib/analyze-action.js
+++ b/lib/analyze-action.js
@@ -92665,12 +92665,14 @@ var AnalysisKind = /* @__PURE__ */ ((AnalysisKind2) => {
 })(AnalysisKind || {});
 var supportedAnalysisKinds = new Set(Object.values(AnalysisKind));
 var CodeScanning = {
+  kind: "code-scanning" /* CodeScanning */,
   name: "code scanning",
   target: "PUT /repos/:owner/:repo/code-scanning/analysis" /* CODE_SCANNING */,
   sarifPredicate: (name) => name.endsWith(".sarif") && !CodeQuality.sarifPredicate(name),
   sentinelPrefix: "CODEQL_UPLOAD_SARIF_"
 };
 var CodeQuality = {
+  kind: "code-quality" /* CodeQuality */,
   name: "code quality",
   target: "PUT /repos/:owner/:repo/code-quality/analysis" /* CODE_QUALITY */,
   sarifPredicate: (name) => name.endsWith(".quality.sarif"),
diff --git a/lib/init-action-post.js b/lib/init-action-post.js
index 49efd6819..4340c5587 100644
--- a/lib/init-action-post.js
+++ b/lib/init-action-post.js
@@ -130479,12 +130479,14 @@ var AnalysisKind = /* @__PURE__ */ ((AnalysisKind2) => {
 })(AnalysisKind || {});
 var supportedAnalysisKinds = new Set(Object.values(AnalysisKind));
 var CodeScanning = {
+  kind: "code-scanning" /* CodeScanning */,
   name: "code scanning",
   target: "PUT /repos/:owner/:repo/code-scanning/analysis" /* CODE_SCANNING */,
   sarifPredicate: (name) => name.endsWith(".sarif") && !CodeQuality.sarifPredicate(name),
   sentinelPrefix: "CODEQL_UPLOAD_SARIF_"
 };
 var CodeQuality = {
+  kind: "code-quality" /* CodeQuality */,
   name: "code quality",
   target: "PUT /repos/:owner/:repo/code-quality/analysis" /* CODE_QUALITY */,
   sarifPredicate: (name) => name.endsWith(".quality.sarif"),
diff --git a/lib/upload-lib.js b/lib/upload-lib.js
index 9bfea1a59..54416cf6a 100644
--- a/lib/upload-lib.js
+++ b/lib/upload-lib.js
@@ -91039,12 +91039,14 @@ var AnalysisKind = /* @__PURE__ */ ((AnalysisKind2) => {
 })(AnalysisKind || {});
 var supportedAnalysisKinds = new Set(Object.values(AnalysisKind));
 var CodeScanning = {
+  kind: "code-scanning" /* CodeScanning */,
   name: "code scanning",
   target: "PUT /repos/:owner/:repo/code-scanning/analysis" /* CODE_SCANNING */,
   sarifPredicate: (name) => name.endsWith(".sarif") && !CodeQuality.sarifPredicate(name),
   sentinelPrefix: "CODEQL_UPLOAD_SARIF_"
 };
 var CodeQuality = {
+  kind: "code-quality" /* CodeQuality */,
   name: "code quality",
   target: "PUT /repos/:owner/:repo/code-quality/analysis" /* CODE_QUALITY */,
   sarifPredicate: (name) => name.endsWith(".quality.sarif"),
diff --git a/lib/upload-sarif-action.js b/lib/upload-sarif-action.js
index 67b010113..b3f5115e9 100644
--- a/lib/upload-sarif-action.js
+++ b/lib/upload-sarif-action.js
@@ -91269,12 +91269,14 @@ var AnalysisKind = /* @__PURE__ */ ((AnalysisKind2) => {
 })(AnalysisKind || {});
 var supportedAnalysisKinds = new Set(Object.values(AnalysisKind));
 var CodeScanning = {
+  kind: "code-scanning" /* CodeScanning */,
   name: "code scanning",
   target: "PUT /repos/:owner/:repo/code-scanning/analysis" /* CODE_SCANNING */,
   sarifPredicate: (name) => name.endsWith(".sarif") && !CodeQuality.sarifPredicate(name),
   sentinelPrefix: "CODEQL_UPLOAD_SARIF_"
 };
 var CodeQuality = {
+  kind: "code-quality" /* CodeQuality */,
   name: "code quality",
   target: "PUT /repos/:owner/:repo/code-quality/analysis" /* CODE_QUALITY */,
   sarifPredicate: (name) => name.endsWith(".quality.sarif"),
diff --git a/src/analyses.ts b/src/analyses.ts
index 175dd463f..e1dd1caec 100644
--- a/src/analyses.ts
+++ b/src/analyses.ts
@@ -47,14 +47,22 @@ export enum SARIF_UPLOAD_ENDPOINT {
 
 // Represents configurations for different analysis kinds.
 export interface AnalysisConfig {
+  /** The analysis kind the configuration is for. */
+  kind: AnalysisKind;
+  /** A display friendly name for logs. */
   name: string;
+  /** The API endpoint to upload SARIF files to. */
   target: SARIF_UPLOAD_ENDPOINT;
+  /** A predicate on filenames to decide whether a SARIF file
+   * belongs to this kind of analysis. */
   sarifPredicate: (name: string) => boolean;
+  /** A prefix for environment variables used to track the uniqueness of SARIF uploads. */
   sentinelPrefix: string;
 }
 
 // Represents the Code Scanning analysis configuration.
 export const CodeScanning: AnalysisConfig = {
+  kind: AnalysisKind.CodeScanning,
   name: "code scanning",
   target: SARIF_UPLOAD_ENDPOINT.CODE_SCANNING,
   sarifPredicate: (name) =>
@@ -64,6 +72,7 @@ export const CodeScanning: AnalysisConfig = {
 
 // Represents the Code Quality analysis configuration.
 export const CodeQuality: AnalysisConfig = {
+  kind: AnalysisKind.CodeQuality,
   name: "code quality",
   target: SARIF_UPLOAD_ENDPOINT.CODE_QUALITY,
   sarifPredicate: (name) => name.endsWith(".quality.sarif"),