Skip to content

Commit 2cbe68f

Browse files
committed
Improve diagnostic message wording
1 parent 02d6683 commit 2cbe68f

4 files changed

Lines changed: 23 additions & 9 deletions

File tree

lib/init-action-post.js

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

lib/init-action.js

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

src/config-utils.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1048,15 +1048,17 @@ export async function initConfig(
10481048
config,
10491049
makeDiagnostic(
10501050
"codeql-action/overlay-skipped-due-to-cached-status",
1051-
"Overlay analysis skipped due to cached status",
1051+
"Skipped improved incremental analysis because it failed previously on this runner",
10521052
{
10531053
attributes: {
10541054
languages: config.languages,
10551055
},
10561056
markdownMessage:
1057-
`Overlay analysis was skipped because it failed previously on this runner. ` +
1058-
"Running CodeQL analysis on a larger runner may allow overlay analysis to run successfully.\n\n" +
1059-
"Overlay analysis will be automatically retried when the next version of CodeQL is released. " +
1057+
`Improved incremental analysis was skipped because it failed previously on this runner. ` +
1058+
"Improved incremental analysis may require a significant amount of disk space on some repositories. " +
1059+
"If you want to enable improved incremental analysis, increase the disk space available " +
1060+
"to the runner, and if that doesn't help, contact GitHub Support for further assistance.\n\n" +
1061+
"Improved incremental analysis will be automatically retried when the next version of CodeQL is released. " +
10601062
`You can also manually trigger a retry by [removing](${DocUrl.DELETE_ACTIONS_CACHE_ENTRIES}) \`codeql-overlay-status-*\` entries from the Actions cache.`,
10611063
severity: "note",
10621064
visibility: {

src/init-action-post-helper.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,15 @@ async function recordOverlayStatus(
288288
logger.debug(
289289
`Saved overlay status to the Actions cache: ${JSON.stringify(overlayStatus)}`,
290290
);
291+
logger.warning(
292+
"This job attempted to run with improved incremental analysis but it did not complete successfully. " +
293+
"This may have been due to disk space constraints: using improved incremental analysis can " +
294+
"require a significant amount of disk space for some repositories. " +
295+
"This information has been saved to the Actions cache. " +
296+
"You can rerun this job to run CodeQL analysis without improved incremental analysis. " +
297+
"If you want to enable improved incremental analysis, increase the disk space available to the runner " +
298+
"and if that doesn't help, contact GitHub Support for further assistance.",
299+
);
291300
} else {
292301
logger.warning(
293302
`Failed to save overlay status to the Actions cache. Status was: ${JSON.stringify(overlayStatus)}`,

0 commit comments

Comments
 (0)