robojerk/codeql-action

Soften deprecation message wording and remove unhelpful version strings from some locations

Browse source
This commit is contained in:
Fotis Koutoulakis (@NlightNFotis) 2024-05-13 11:39:50 +01:00 • committed by Fotis Koutoulakis
parent bcc13653e8
commit df4819e3a1
6 changed files with 38 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/setup-codeql.test.ts
View file

@ -134,7 +134,7 @@ test("getCodeQLSource correctly returns bundled CLI version when tools == latest
// Afterwards, ensure that we see the deprecation message in the log.
const expected_message: string =
"The 'latest' alias for the CodeQL tools has been deprecated. Please use 'linked' instead.";
"`tools: latest` has been renamed to `tools: linked`, but the old name is still supported for now. No action is required.";
t.assert(
loggedMessages.some(
(msg) =>
@ -216,7 +216,7 @@ test("setupCodeQLBundle logs the CodeQL CLI version being used when asked to dow
t.is(result.toolsVersion, expectedVersion);
// Ensure message logging CodeQL CLI version was present in user logs.
const expected_message: string = `Using CodeQL CLI version 2.16.0 downloaded from ${bundleUrl}.`;
const expected_message: string = `Using CodeQL CLI version 2.16.0 sourced from ${bundleUrl}.`;
t.assert(
loggedMessages.some(
(msg) =>

28
src/setup-codeql.ts
View file

@ -288,7 +288,7 @@ export async function getCodeQLSource(
!CODEQL_BUNDLE_VERSION_ALIAS.includes(toolsInput) &&
!toolsInput.startsWith("http")
) {
logger.info("Using CodeQL CLI from local path $path");
logger.info(`Using CodeQL CLI from local path ${toolsInput}`);
return {
codeqlTarPath: toolsInput,
sourceType: "local",
@ -317,7 +317,7 @@ export async function getCodeQLSource(
if (toolsInput === "latest") {
logger.warning(
"The 'latest' alias for the CodeQL tools has been deprecated. Please use 'linked' instead.",
"`tools: latest` has been renamed to `tools: linked`, but the old name is still supported for now. No action is required.",
);
}
}
@ -442,14 +442,17 @@ export async function getCodeQLSource(
}
if (codeqlFolder) {
const version = cliVersion ?? humanReadableVersion;
logger.info(
`Using CodeQL CLI version ${version} from toolcache at ${codeqlFolder}`,
);
if (cliVersion) {
logger.info(
`Using CodeQL CLI version ${cliVersion} from toolcache at ${codeqlFolder}`,
);
} else {
logger.info(`Using CodeQL CLI from toolcache at ${codeqlFolder}`);
}
return {
codeqlFolder,
sourceType: "toolcache",
toolsVersion: version,
toolsVersion: cliVersion ?? humanReadableVersion,
};
}
@ -474,16 +477,17 @@ export async function getCodeQLSource(
url = await getCodeQLBundleDownloadURL(tagName!, apiDetails, logger);
}
const toolsVersion = cliVersion ?? humanReadableVersion;
logger.info(
`Using CodeQL CLI version ${toolsVersion} downloaded from ${url}.`,
);
if (cliVersion) {
logger.info(`Using CodeQL CLI version ${cliVersion} sourced from ${url}.`);
} else {
logger.info(`Using CodeQL CLI sourced from ${url}.`);
}
return {
bundleVersion: tagName && tryGetBundleVersionFromTagName(tagName, logger),
cliVersion,
codeqlURL: url,
sourceType: "download",
toolsVersion,
toolsVersion: cliVersion ?? humanReadableVersion,
};
}