8000 Soften deprecation message wording and remove unhelpful version strin… · github/codeql-action@b24e695 · GitHub
[go: up one dir, main page]
Skip to content

Commit b24e695

Browse files
NlightNFotisNlightNFotis
committed
Soften deprecation message wording and remove unhelpful version strings from some locations
1 parent 5a08657 commit b24e695

File tree

6 files changed

+38
-26
lines changed

6 files changed

+38
-26
lines changed

‎lib/setup-codeql.js

Lines changed: 16 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎lib/setup-codeql.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎lib/setup-codeql.test.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎lib/setup-codeql.test.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/setup-codeql.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ test("getCodeQLSource correctly returns bundled CLI version when tools == latest
134134

135135
// Afterwards, ensure that we see the deprecation message in the log.
136136
const expected_message: string =
137-
"The 'latest' alias for the CodeQL tools has been deprecated. Please use 'linked' instead.";
137+
"`tools: latest` has been renamed to `tools: linked`, but the old name is still supported for now. No action is required.";
138138
t.assert(
139139
loggedMessages.some(
140140
(msg) =>
@@ -216,7 +216,7 @@ test("setupCodeQLBundle logs the CodeQL CLI version being used when asked to dow
216216
t.is(result.toolsVersion, expectedVersion);
217217

218218
// Ensure message logging CodeQL CLI version was present in user logs.
219-
const expected_message: string = `Using CodeQL CLI version 2.16.0 downloaded from ${bundleUrl}.`;
219+
const expected_message: string = `Using CodeQL CLI version 2.16.0 sourced from ${bundleUrl}.`;
220220
t.assert(
221221
loggedMessages.some(
222222
(msg) =>

‎src/setup-codeql.ts

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ export async function getCodeQLSource(
288288
!CODEQL_BUNDLE_VERSION_ALIAS.includes(toolsInput) &&
289289
!toolsInput.startsWith("http")
290290
) {
291-
logger.info("Using CodeQL CLI from local path $path");
291+
logger.info(`Using CodeQL CLI from local path ${toolsInput}`);
292292
return {
293293
codeqlTarPath: toolsInput,
294294
sourceType: "local",
@@ -317,7 +317,7 @@ export async function getCodeQLSource(
317317

318318
if (toolsInput === "latest") {
319319
logger.warning(
320-
"The 'latest' alias for the CodeQL tools has been deprecated. Please use 'linked' instead.",
320+
"`tools: latest` has been renamed to `tools: linked`, but the old name is still supported for now. No action is required.",
321321
);
322322
}
323323
}
@@ -442,14 +442,17 @@ export async function getCodeQLSource(
442442
}
443443

444444
if (codeqlFolder) {
445-
const version = cliVersion ?? humanReadableVersion;
446-
logger.info(
447-
`Using CodeQL CLI version ${version} from toolcache at ${codeqlFolder}`,
448-
);
445+
if (cliVersion) {
446+
logger.info(
447+
`Using CodeQL CLI version ${cliVersion} from toolcache at ${codeqlFolder}`,
448+
);
449+
} else {
450+
logger.info(`Using CodeQL CLI from toolcache at ${codeqlFolder}`);
451+
}
449452
return {
450453
codeqlFolder,
451454
sourceType: "toolcache",
452-
toolsVersion: version,
455+
toolsVersion: cliVersion ?? humanReadableVersion,
453456
};
454457
}
455458

@@ -474,16 +477,17 @@ export async function getCodeQLSource(
474477
url = await getCodeQLBundleDownloadURL(tagName!, apiDetails, logger);
475478
}
476479

477-
const toolsVersion = cliVersion ?? humanReadableVersion;
478-
logger.info(
479-
`Using CodeQL CLI version ${toolsVersion} downloaded from ${url}.`,
480-
);
480+
if (cliVersion) {
481+
logger.info(`Using CodeQL CLI version ${cliVersion} sourced from ${url}.`);
482+
} else {
483+
logger.info(`Using CodeQL CLI sourced from ${url}.`);
484+
}
481485
return {
482486
bundleVersion: tagName && tryGetBundleVersionFromTagName(tagName, logger),
483487
cliVersion,
484488
codeqlURL: url,
485489
sourceType: "download",
486-
toolsVersion,
490+
toolsVersion: cliVersion ?? humanReadableVersion,
487491
};
488492
}
489493

0 commit comments

Comments
 (0)
0