add v2 deprecation warning #2092
Conversation
nickfyson
force-pushed
the
nickfyson/v2-deprecation-warning
branch
4 times, most recently
from
a1ec01e
to
774d2c3
Compare
nickfyson
force-pushed
the
nickfyson/v2-deprecation-warning
branch
from
ed17f48
to
f72cffc
Compare
src/util.ts
Outdated
| @@ -944,3 +944,38 @@ export async function checkDiskUsage(logger?: Logger): Promise<DiskUsage> { | |||
| numTotalBytes: diskUsage.size, | |||
| }; | |||
| } | |||
|
|
|||
| /** | |||
| * Prompt the customer to upgrade to CodeQL Action v2, if appropriate. | |||
There was a problem hiding this comment.
| * Prompt the customer to upgrade to CodeQL Action v2, if appropriate. | |
| * Prompt the customer to upgrade to CodeQL Action v3, if appropriate. |
src/util.ts
Outdated
| core.warning( | ||
| "CodeQL Action v2 will be deprecated on December 5th, 2024. Please upgrade to v3. For " + | ||
| "more information, see " + | ||
| "https://github.blog/changelog/2024-01-12-code-scanning-deprecation-of-codeql-action-v2/", | ||
| ); |
There was a problem hiding this comment.
We could optionally set an environment variable such that we only show this warning for the first Action you run, so it only appears once in the workflow logs (at least per job).
There was a problem hiding this comment.
I'd wondered whether we should be including the action name in the warning message, so in general users would still get multiple warnings for a job but each would refer to a specific action. Makes things more explicit? 🤷♂️
There was a problem hiding this comment.
(though, we're linking to the changelog where the individual actions are listed, so probably is better to just limit ourselves to one warning...)
There was a problem hiding this comment.
We could change the phrasing to something like "Please update all occurrences of the CodeQL Action in your workflow files to v3"?
There was a problem hiding this comment.
👍 I've pushed updates, and included links in the description that demonstrate that the limit to one warning is working.
nickfyson
dismissed stale reviews from henrymercer and aeisenberg
via
a854253
This PR adds a deprecation warning when
v2of any CodeQL Action is found to be running on a GitHub instance that is capable of upgrading tov3.The following three workflow runs demonstrate these changes...
v2of the actionMerge / deployment checklist