Skip to content

Commit a9eb86f

Browse files
committed
Differentiate setupCodeql.setupCodeQL from codeql.setupCodeQL
1 parent d8b5f79 commit a9eb86f

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

lib/codeql.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/codeql.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/setup-codeql.js

+5-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/setup-codeql.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/codeql.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ export async function setupCodeQL(
302302
checkVersion: boolean
303303
): Promise<{ codeql: CodeQL; toolsVersion: string }> {
304304
try {
305-
const { codeqlFolder, toolsVersion } = await setupCodeql.setupCodeQL(
305+
const { codeqlFolder, toolsVersion } = await setupCodeql.setupCodeQLBundle(
306306
toolsInput,
307307
apiDetails,
308308
tempDir,

src/setup-codeql.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ export function getCodeQLURLVersion(url: string): string {
446446
}
447447

448448
/**
449-
* Set up CodeQL CLI access.
449+
* Obtains the CodeQL bundle, installs it in the toolcache if appropriate, and extracts it.
450450
*
451451
* @param toolsInput
452452
* @param apiDetails
@@ -457,9 +457,9 @@ export function getCodeQLURLVersion(url: string): string {
457457
* @param logger
458458
* @param checkVersion Whether to check that CodeQL CLI meets the minimum
459459
* version requirement. Must be set to true outside tests.
460-
* @returns a { CodeQL, toolsVersion } object.
460+
* @returns the path to the extracted bundle, and the version of the tools
461461
*/
462-
export async function setupCodeQL(
462+
export async function setupCodeQLBundle(
463463
toolsInput: string | undefined,
464464
apiDetails: api.GitHubApiDetails,
465465
tempDir: string,

0 commit comments

Comments
 (0)