Merge branch 'main' into henrymercer/controlled-switchover

CHANGELOG.md

@@ -17,6 +17,9 @@
 
     Where possible, we recommend downloading and managing the CodeQL CLI via the [CodeQL extension for the GitHub CLI](https://github.com/github/gh-codeql) or [GitHub Releases](https://github.com/github/codeql-cli-binaries/releases) rather than using the CodeQL tools from the runner image tool cache.
 - Python automatic dependency installation will no longer fail for projects using Poetry that specify `virtualenvs.options.no-pip = true` in their `poetry.toml`. [#1431](https://github.com/github/codeql-action/pull/1431).
+- Avoid printing a stack trace and error message when the action fails to find the SHA at the
+  current directory. This will happen in several non-error states and so we now avoid cluttering the
+  log with this message. [#1485](https://github.com/github/codeql-action/pull/1485)
 
 ## 2.1.38 - 12 Jan 2023
 

lib/actions-util.js

@@ -88,8 +88,9 @@ const getCommitOid = async function (checkoutPath, ref = "HEAD") {
         return commitOid.trim();
     }
     catch (e) {
-        core.info(`Failed to call git to get current commit. Continuing with data from environment or input: ${e}`);
-        core.info(e.stack || "NO STACK");
+        core.info("Could not determine current commit SHA using git. Continuing with data from user input or environment.");
+        core.debug(`Reason: ${e.message}`);
+        core.debug(e.stack || "NO STACK");
         return (0, exports.getOptionalInput)("sha") || (0, util_1.getRequiredEnvParam)("GITHUB_SHA");
     }
 };

lib/analyze.js

@@ -127,12 +127,6 @@ async function runQueries(sarifFolder, memoryFlag, addSnippetsFlag, threadsFlag,
         const queries = config.queries[language];
         const queryFilters = validateQueryFilters(config.originalUserInput["query-filters"]);
         const packsWithVersion = config.packs[language] || [];
-        const hasBuiltinQueries = (queries === null || queries === void 0 ? void 0 : queries.builtin.length) > 0;
-        const hasCustomQueries = (queries === null || queries === void 0 ? void 0 : queries.custom.length) > 0;
-        const hasPackWithCustomQueries = packsWithVersion.length > 0;
-        if (!hasBuiltinQueries && !hasCustomQueries && !hasPackWithCustomQueries) {
-            throw new Error(`Unable to analyze ${language} as no queries were selected for this language`);
-        }
         try {
             if (await util.useCodeScanningConfigInCli(codeql, featureEnablement)) {
                 // If we are using the code scanning config in the CLI,
@@ -158,6 +152,14 @@ async function runQueries(sarifFolder, memoryFlag, addSnippetsFlag, threadsFlag,
             }
             else {
                 // config was generated by the action, so must be interpreted by the action.
+                const hasBuiltinQueries = (queries === null || queries === void 0 ? void 0 : queries.builtin.length) > 0;
+                const hasCustomQueries = (queries === null || queries === void 0 ? void 0 : queries.custom.length) > 0;
+                const hasPackWithCustomQueries = packsWithVersion.length > 0;
+                if (!hasBuiltinQueries &&
+                    !hasCustomQueries &&
+                    !hasPackWithCustomQueries) {
+                    throw new Error(`Unable to analyze ${language} as no queries were selected for this language`);
+                }
                 logger.startGroup(`Running queries for ${language}`);
                 const querySuitePaths = [];
                 if (queries["builtin"].length > 0) {

lib/api-compatibility.json

@@ -1 +1 @@
-{ "maximumVersion": "3.8", "minimumVersion": "3.3" }
+{ "maximumVersion": "3.8", "minimumVersion": "3.4" }

lib/codeql.js

@@ -290,7 +290,7 @@ async function getCodeQLForCmd(cmd, checkVersion) {
                 ...getExtraOptionsFromEnv(["database", "init"]),
             ]);
         },
-        async databaseInitCluster(config, sourceRoot, processName, featureEnablement) {
+        async databaseInitCluster(config, sourceRoot, processName, featureEnablement, logger) {
             const extraArgs = config.languages.map((language) => `--language=${language}`);
             if (config.languages.filter((l) => (0, languages_1.isTracedLanguage)(l)).length > 0) {
                 extraArgs.push("--begin-tracing");
@@ -309,7 +309,7 @@ async function getCodeQLForCmd(cmd, checkVersion) {
                 }
             }
             // A config file is only generated if the CliConfigFileEnabled feature flag is enabled.
-            const configLocation = await generateCodeScanningConfig(codeql, config, featureEnablement);
+            const configLocation = await generateCodeScanningConfig(codeql, config, featureEnablement, logger);
             // Only pass external repository token if a config file is going to be parsed by the CLI.
             let externalRepositoryToken;
             if (configLocation) {
@@ -696,7 +696,7 @@ async function runTool(cmd, args = [], opts = {}) {
  * @param config The configuration to use.
  * @returns the path to the generated user configuration file.
  */
-async function generateCodeScanningConfig(codeql, config, featureEnablement) {
+async function generateCodeScanningConfig(codeql, config, featureEnablement, logger) {
     var _a;
     if (!(await util.useCodeScanningConfigInCli(codeql, featureEnablement))) {
         return;
@@ -755,6 +755,10 @@ async function generateCodeScanningConfig(codeql, config, featureEnablement) {
             augmentedConfig.packs["javascript"].push(packString);
         }
     }
+    logger.info(`Writing augmented user configuration file to ${configLocation}`);
+    logger.startGroup("Augmented user configuration file contents");
+    logger.info(yaml.dump(augmentedConfig));
+    logger.endGroup();
     fs.writeFileSync(configLocation, yaml.dump(augmentedConfig));
     return configLocation;
 }

src/actions-util.ts

@@ -88,9 +88,10 @@ export const getCommitOid = async function (
     return commitOid.trim();
   } catch (e) {
     core.info(
-      `Failed to call git to get current commit. Continuing with data from environment or input: ${e}`
+      "Could not determine current commit SHA using git. Continuing with data from user input or environment."
     );
-    core.info((e as Error).stack || "NO STACK");
+    core.debug(`Reason: ${(e as Error).message}`);
+    core.debug((e as Error).stack || "NO STACK");
     return getOptionalInput("sha") || getRequiredEnvParam("GITHUB_SHA");
   }
 };

src/analyze.ts

@@ -222,16 +222,6 @@ export async function runQueries(
     );
     const packsWithVersion = config.packs[language] || [];
 
-    const hasBuiltinQueries = queries?.builtin.length > 0;
-    const hasCustomQueries = queries?.custom.length > 0;
-    const hasPackWithCustomQueries = packsWithVersion.length > 0;
-
-    if (!hasBuiltinQueries && !hasCustomQueries && !hasPackWithCustomQueries) {
-      throw new Error(
-        `Unable to analyze ${language} as no queries were selected for this language`
-      );
-    }
-
     try {
       if (await util.useCodeScanningConfigInCli(codeql, featureEnablement)) {
         // If we are using the code scanning config in the CLI,
@@ -262,6 +252,21 @@ export async function runQueries(
         logger.info(analysisSummary);
       } else {
         // config was generated by the action, so must be interpreted by the action.
+
+        const hasBuiltinQueries = queries?.builtin.length > 0;
+        const hasCustomQueries = queries?.custom.length > 0;
+        const hasPackWithCustomQueries = packsWithVersion.length > 0;
+
+        if (
+          !hasBuiltinQueries &&
+          !hasCustomQueries &&
+          !hasPackWithCustomQueries
+        ) {
+          throw new Error(
+            `Unable to analyze ${language} as no queries were selected for this language`
+          );
+        }
+
         logger.startGroup(`Running queries for ${language}`);
         const querySuitePaths: string[] = [];
         if (queries["builtin"].length > 0) {

src/api-compatibility.json

@@ -1 +1 @@
-{"maximumVersion": "3.8", "minimumVersion": "3.3"}
+{"maximumVersion": "3.8", "minimumVersion": "3.4"}

src/codeql.ts

@@ -544,7 +544,8 @@ export async function getCodeQLForCmd(
       config: Config,
       sourceRoot: string,
       processName: string | undefined,
-      featureEnablement: FeatureEnablement
+      featureEnablement: FeatureEnablement,
+      logger: Logger
     ) {
       const extraArgs = config.languages.map(
         (language) => `--language=${language}`
@@ -577,7 +578,8 @@ export async function getCodeQLForCmd(
       const configLocation = await generateCodeScanningConfig(
         codeql,
         config,
-        featureEnablement
+        featureEnablement,
+        logger
       );
       // Only pass external repository token if a config file is going to be parsed by the CLI.
       let externalRepositoryToken: string | undefined;
@@ -1075,7 +1077,8 @@ async function runTool(
 async function generateCodeScanningConfig(
   codeql: CodeQL,
   config: Config,
-  featureEnablement: FeatureEnablement
+  featureEnablement: FeatureEnablement,
+  logger: Logger
 ): Promise<string | undefined> {
   if (!(await util.useCodeScanningConfigInCli(codeql, featureEnablement))) {
     return;
@@ -1137,6 +1140,10 @@ async function generateCodeScanningConfig(
       augmentedConfig.packs["javascript"].push(packString);
     }
   }
+  logger.info(`Writing augmented user configuration file to ${configLocation}`);
+  logger.startGroup("Augmented user configuration file contents");
+  logger.info(yaml.dump(augmentedConfig));
+  logger.endGroup();
 
   fs.writeFileSync(configLocation, yaml.dump(augmentedConfig));
   return configLocation;