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

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

24
lib/setup-codeql.js generated
View File

@@ -226,7 +226,7 @@ async function getCodeQLSource(toolsInput, defaultCliVersion, apiDetails, varian
if (toolsInput &&
!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",
@@ -249,7 +249,7 @@ async function getCodeQLSource(toolsInput, defaultCliVersion, apiDetails, varian
logger.info(`Overriding the version of the CodeQL tools by ${defaultCliVersion.cliVersion}, the version shipped with the Action since ` +
`tools: ${toolsInput} was requested.`);
if (toolsInput === "latest") {
logger.warning("The 'latest' alias for the CodeQL tools has been deprecated. Please use 'linked' instead.");
logger.warning("`tools: latest` has been renamed to `tools: linked`, but the old name is still supported for now. No action is required.");
}
}
/** CLI version number, for example 2.12.6. */
@@ -340,12 +340,16 @@ async function getCodeQLSource(toolsInput, defaultCliVersion, apiDetails, varian
logger.info(`Did not find CodeQL tools version ${humanReadableVersion} in the toolcache.`);
}
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,
};
}
// If we don't find the requested version on Enterprise, we may allow a
@@ -362,14 +366,18 @@ async function getCodeQLSource(toolsInput, defaultCliVersion, apiDetails, varian
if (!url) {
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,
};
}
exports.getCodeQLSource = getCodeQLSource;