Add category option to runner

lib/runner.js

@@ -217,6 +217,7 @@ program
     .option("--threads <threads>", "Number of threads to use when running queries. " +
     "Default is to use all available cores.")
     .option("--temp-dir <dir>", 'Directory to use for temporary files. Default is "./codeql-runner".')
+    .option("--category <category>", "String used by Code Scanning for matching the analyses.")
     .option("--debug", "Print more verbose output", false)
     .action(async (cmd) => {
     const logger = logging_1.getRunnerLogger(cmd.debug);
@@ -237,7 +238,7 @@ program
             logger.info("Not uploading results");
             return;
         }
-        await upload_lib.uploadFromRunner(outputDir, repository_1.parseRepositoryNwo(cmd.repository), cmd.commit, parseRef(cmd.ref), cmd.checkoutPath || process.cwd(), config.gitHubVersion, apiDetails, logger);
+        await upload_lib.uploadFromRunner(outputDir, repository_1.parseRepositoryNwo(cmd.repository), cmd.commit, parseRef(cmd.ref), cmd.category, cmd.checkoutPath || process.cwd(), config.gitHubVersion, apiDetails, logger);
     }
     catch (e) {
         logger.error("Analyze failed");
@@ -256,6 +257,7 @@ program
     .option("--github-auth <auth>", "GitHub Apps token or personal access token. This option is insecure and deprecated, please use `--github-auth-stdin` instead.")
     .option("--github-auth-stdin", "Read GitHub Apps token or personal access token from stdin.")
     .option("--checkout-path <path>", "Checkout path. Default is the current working directory.")
+    .option("--category <category>", "String used by Code Scanning for matching the analyses.")
     .option("--debug", "Print more verbose output", false)
     .action(async (cmd) => {
     const logger = logging_1.getRunnerLogger(cmd.debug);
@@ -266,7 +268,7 @@ program
     };
     try {
         const gitHubVersion = await util_1.getGitHubVersion(apiDetails);
-        await upload_lib.uploadFromRunner(cmd.sarifFile, repository_1.parseRepositoryNwo(cmd.repository), cmd.commit, parseRef(cmd.ref), cmd.checkoutPath || process.cwd(), gitHubVersion, apiDetails, logger);
+        await upload_lib.uploadFromRunner(cmd.sarifFile, repository_1.parseRepositoryNwo(cmd.repository), cmd.commit, parseRef(cmd.ref), cmd.category, cmd.checkoutPath || process.cwd(), gitHubVersion, apiDetails, logger);
     }
     catch (e) {
         logger.error("Upload failed");

lib/upload-lib.js

@@ -140,8 +140,8 @@ exports.uploadFromActions = uploadFromActions;
 // Uploads a single sarif file or a directory of sarif files
 // depending on what the path happens to refer to.
 // Returns true iff the upload occurred and succeeded
-async function uploadFromRunner(sarifPath, repositoryNwo, commitOid, ref, checkoutPath, gitHubVersion, apiDetails, logger) {
-    return await uploadFiles(getSarifFilePaths(sarifPath), repositoryNwo, commitOid, ref, undefined, undefined, undefined, undefined, checkoutPath, undefined, gitHubVersion, apiDetails, "runner", logger);
+async function uploadFromRunner(sarifPath, repositoryNwo, commitOid, ref, category, checkoutPath, gitHubVersion, apiDetails, logger) {
+    return await uploadFiles(getSarifFilePaths(sarifPath), repositoryNwo, commitOid, ref, undefined, category, undefined, undefined, checkoutPath, undefined, gitHubVersion, apiDetails, "runner", logger);
 }
 exports.uploadFromRunner = uploadFromRunner;
 function getSarifFilePaths(sarifPath) {

src/runner.ts

@@ -324,6 +324,7 @@ interface AnalyzeArgs {
   repository: string;
   commit: string;
   ref: string;
+  category: string | undefined;
   githubUrl: string;
   githubAuth: string;
   githubAuthStdin: boolean;
@@ -381,6 +382,10 @@ program
     "--temp-dir <dir>",
     'Directory to use for temporary files. Default is "./codeql-runner".'
   )
+  .option(
+    "--category <category>",
+    "String used by Code Scanning for matching the analyses."
+  )
   .option("--debug", "Print more verbose output", false)
   .action(async (cmd: AnalyzeArgs) => {
     const logger = getRunnerLogger(cmd.debug);
@@ -425,6 +430,7 @@ program
         parseRepositoryNwo(cmd.repository),
         cmd.commit,
         parseRef(cmd.ref),
+        cmd.category,
         cmd.checkoutPath || process.cwd(),
         config.gitHubVersion,
         apiDetails,
@@ -442,6 +448,7 @@ interface UploadArgs {
   repository: string;
   commit: string;
   ref: string;
+  category: string | undefined;
   githubUrl: string;
   githubAuthStdin: boolean;
   githubAuth: string;
@@ -477,6 +484,10 @@ program
     "--checkout-path <path>",
     "Checkout path. Default is the current working directory."
   )
+  .option(
+    "--category <category>",
+    "String used by Code Scanning for matching the analyses."
+  )
   .option("--debug", "Print more verbose output", false)
   .action(async (cmd: UploadArgs) => {
     const logger = getRunnerLogger(cmd.debug);
@@ -496,6 +507,7 @@ program
         parseRepositoryNwo(cmd.repository),
         cmd.commit,
         parseRef(cmd.ref),
+        cmd.category,
         cmd.checkoutPath || process.cwd(),
         gitHubVersion,
         apiDetails,

src/upload-lib.ts

@@ -199,6 +199,7 @@ export async function uploadFromRunner(
   repositoryNwo: RepositoryNwo,
   commitOid: string,
   ref: string,
+  category: string | undefined,
   checkoutPath: string,
   gitHubVersion: util.GitHubVersion,
   apiDetails: api.GitHubApiDetails,
@@ -210,7 +211,7 @@ export async function uploadFromRunner(
     commitOid,
     ref,
     undefined,
-    undefined,
+    category,
     undefined,
     undefined,
     checkoutPath,