Differentiate setupCodeql.setupCodeQL from codeql.setupCodeQL

github · Jan 11, 2023 · a9eb86f · a9eb86f
1 parent d8b5f79
commit a9eb86f
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 12 deletions.
diff --git a/lib/codeql.js b/lib/codeql.js
diff --git a/lib/codeql.js.map b/lib/codeql.js.map
diff --git a/lib/setup-codeql.js b/lib/setup-codeql.js
diff --git a/lib/setup-codeql.js.map b/lib/setup-codeql.js.map
diff --git a/src/codeql.ts b/src/codeql.ts
@@ -302,7 +302,7 @@ export async function setupCodeQL(
   checkVersion: boolean
 ): Promise<{ codeql: CodeQL; toolsVersion: string }> {
   try {
-    const { codeqlFolder, toolsVersion } = await setupCodeql.setupCodeQL(
+    const { codeqlFolder, toolsVersion } = await setupCodeql.setupCodeQLBundle(
       toolsInput,
       apiDetails,
       tempDir,

diff --git a/src/setup-codeql.ts b/src/setup-codeql.ts
@@ -446,7 +446,7 @@ export function getCodeQLURLVersion(url: string): string {
 }
 
 /**
- * Set up CodeQL CLI access.
+ * Obtains the CodeQL bundle, installs it in the toolcache if appropriate, and extracts it.
  *
  * @param toolsInput
  * @param apiDetails
@@ -457,9 +457,9 @@ export function getCodeQLURLVersion(url: string): string {
  * @param logger
  * @param checkVersion Whether to check that CodeQL CLI meets the minimum
  *        version requirement. Must be set to true outside tests.
- * @returns a { CodeQL, toolsVersion } object.
+ * @returns the path to the extracted bundle, and the version of the tools
  */
-export async function setupCodeQL(
+export async function setupCodeQLBundle(
   toolsInput: string | undefined,
   apiDetails: api.GitHubApiDetails,
   tempDir: string,