Tweak a couple of log messages

This commit is contained in:
Henry Mercer
2024-10-22 21:19:34 +01:00
parent 06361b4d2b
commit e5048f5d84
6 changed files with 8 additions and 10 deletions

5
lib/setup-codeql.js generated
View File

@@ -219,10 +219,9 @@ async function getCodeQLSource(toolsInput, defaultCliVersion, apiDetails, varian
*/ */
const forceShippedTools = toolsInput && CODEQL_BUNDLE_VERSION_ALIAS.includes(toolsInput); const forceShippedTools = toolsInput && CODEQL_BUNDLE_VERSION_ALIAS.includes(toolsInput);
if (forceShippedTools) { if (forceShippedTools) {
logger.info(`Overriding the version of the CodeQL tools by ${defaultCliVersion.cliVersion}, the version shipped with the Action since ` + logger.info(`'tools: ${toolsInput}' was requested, so using CodeQL version ${defaultCliVersion.cliVersion}, the version shipped with the Action.`);
`tools: ${toolsInput} was requested.`);
if (toolsInput === "latest") { if (toolsInput === "latest") {
logger.warning("`tools: latest` has been renamed to `tools: linked`, but the old name is still supported for now. No action is required."); logger.warning("`tools: latest` has been renamed to `tools: linked`, but the old name is still supported. No action is required.");
} }
} }
/** CLI version number, for example 2.12.6. */ /** CLI version number, for example 2.12.6. */

File diff suppressed because one or more lines are too long

View File

@@ -103,7 +103,7 @@ ava_1.default.beforeEach(() => {
t.is(source.toolsVersion, testing_utils_1.LINKED_CLI_VERSION.cliVersion); t.is(source.toolsVersion, testing_utils_1.LINKED_CLI_VERSION.cliVersion);
t.is(source.sourceType, "download"); t.is(source.sourceType, "download");
// Afterwards, ensure that we see the deprecation message in the log. // Afterwards, ensure that we see the deprecation message in the log.
const expected_message = "`tools: latest` has been renamed to `tools: linked`, but the old name is still supported for now. No action is required."; const expected_message = "`tools: latest` has been renamed to `tools: linked`, but the old name is still supported. No action is required.";
t.assert(loggedMessages.some((msg) => typeof msg.message === "string" && t.assert(loggedMessages.some((msg) => typeof msg.message === "string" &&
msg.message.includes(expected_message))); msg.message.includes(expected_message)));
}); });

File diff suppressed because one or more lines are too long

View File

@@ -141,7 +141,7 @@ test("getCodeQLSource correctly returns bundled CLI version when tools == latest
// Afterwards, ensure that we see the deprecation message in the log. // Afterwards, ensure that we see the deprecation message in the log.
const expected_message: string = const expected_message: string =
"`tools: latest` has been renamed to `tools: linked`, but the old name is still supported for now. No action is required."; "`tools: latest` has been renamed to `tools: linked`, but the old name is still supported. No action is required.";
t.assert( t.assert(
loggedMessages.some( loggedMessages.some(
(msg) => (msg) =>

View File

@@ -274,13 +274,12 @@ export async function getCodeQLSource(
toolsInput && CODEQL_BUNDLE_VERSION_ALIAS.includes(toolsInput); toolsInput && CODEQL_BUNDLE_VERSION_ALIAS.includes(toolsInput);
if (forceShippedTools) { if (forceShippedTools) {
logger.info( logger.info(
`Overriding the version of the CodeQL tools by ${defaultCliVersion.cliVersion}, the version shipped with the Action since ` + `'tools: ${toolsInput}' was requested, so using CodeQL version ${defaultCliVersion.cliVersion}, the version shipped with the Action.`,
`tools: ${toolsInput} was requested.`,
); );
if (toolsInput === "latest") { if (toolsInput === "latest") {
logger.warning( logger.warning(
"`tools: latest` has been renamed to `tools: linked`, but the old name is still supported for now. No action is required.", "`tools: latest` has been renamed to `tools: linked`, but the old name is still supported. No action is required.",
); );
} }
} }