github/codeql-action
1
0
Fork 0
mirror of https://github.com/github/codeql-action.git synced 2026-10-30 17:39:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve diagnostic message wording

Browse Source
This commit is contained in:
Henry Mercer
2026-02-17 13:38:07 +00:00
parent ef58c00dfe
commit cc0dce044b
4 changed files with 23 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/config-utils.ts
View File

@@ -1047,15 +1047,17 @@ export async function initConfig(
config,
makeDiagnostic(
"codeql-action/overlay-skipped-due-to-cached-status",
"Overlay analysis skipped due to cached status",
"Skipped improved incremental analysis because it failed previously on this runner",
{
attributes: {
languages: config.languages,
},
markdownMessage:
`Overlay analysis was skipped because it failed previously on this runner. ` +
"Running CodeQL analysis on a larger runner may allow overlay analysis to run successfully.\n\n" +
"Overlay analysis will be automatically retried when the next version of CodeQL is released. " +
`Improved incremental analysis was skipped because it failed previously on this runner. ` +
"Improved incremental analysis may require a significant amount of disk space on some repositories. " +
"If you want to enable improved incremental analysis, increase the disk space available " +
"to the runner, and if that doesn't help, contact GitHub Support for further assistance.\n\n" +
"Improved incremental analysis will be automatically retried when the next version of CodeQL is released. " +
`You can also manually trigger a retry by [removing](${DocUrl.DELETE_ACTIONS_CACHE_ENTRIES}) \`codeql-overlay-status-*\` entries from the Actions cache.`,
severity: "note",
visibility: {

9
src/init-action-post-helper.ts
View File

@@ -288,6 +288,15 @@ async function recordOverlayStatus(
logger.debug(
`Saved overlay status to the Actions cache: ${JSON.stringify(overlayStatus)}`,
);
logger.warning(
"This job attempted to run with improved incremental analysis but it did not complete successfully. " +
"This may have been due to disk space constraints: using improved incremental analysis can " +
"require a significant amount of disk space for some repositories. " +
"This information has been saved to the Actions cache. " +
"You can rerun this job to run CodeQL analysis without improved incremental analysis. " +
"If you want to enable improved incremental analysis, increase the disk space available to the runner " +
"and if that doesn't help, contact GitHub Support for further assistance.",
);
} else {
logger.warning(
`Failed to save overlay status to the Actions cache. Status was: ${JSON.stringify(overlayStatus)}`,