Merge pull request #2668 from github/sidshank/improve-autobuilder-log…

…-message Make the Autobuilder log message referring to build modes clearer
github · Jan 6, 2025 · 3407610 · 3407610
2 parents 5b6e617 + 5bf0e05
commit 3407610
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 4 deletions.
diff --git a/lib/autobuild.js b/lib/autobuild.js
diff --git a/lib/autobuild.js.map b/lib/autobuild.js.map
diff --git a/lib/doc-url.js b/lib/doc-url.js
diff --git a/lib/doc-url.js.map b/lib/doc-url.js.map
diff --git a/src/autobuild.ts b/src/autobuild.ts
@@ -23,7 +23,10 @@ export async function determineAutobuildLanguages(
       (await codeql.supportsFeature(ToolsFeature.TraceCommandUseBuildMode))) ||
     config.buildMode === BuildMode.Manual
   ) {
-    logger.info(`Using ${config.buildMode} build mode, nothing to autobuild.`);
+    logger.info(
+      `Using build mode "${config.buildMode}", nothing to autobuild. ` +
+        `See ${DocUrl.CODEQL_BUILD_MODES} for more information.`,
+    );
     return undefined;
   }
 

diff --git a/src/doc-url.ts b/src/doc-url.ts
@@ -9,4 +9,5 @@ export enum DocUrl {
   SCANNING_ON_PUSH = "https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#scanning-on-push",
   SPECIFY_BUILD_STEPS_MANUALLY = "https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages#about-specifying-build-steps-manually",
   TRACK_CODE_SCANNING_ALERTS_ACROSS_RUNS = "https://docs.github.com/en/enterprise-cloud@latest/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning#providing-data-to-track-code-scanning-alerts-across-runs",
+  CODEQL_BUILD_MODES = "https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages#codeql-build-modes",
 }