Add diagnostic when overlay disabled by repo property

Author: henrymercer

lib/init-action.js

@@ -1019,6 +1019,7 @@ const getOverlayDatabaseModeMacro = test.macro({
       overlayDatabaseMode: OverlayDatabaseMode;
       useOverlayDatabaseCaching: boolean;
       skippedDueToCachedStatus?: boolean;
+      disabledByRepositoryProperty?: boolean;
     },
   ) => {
     return await withTmpDir(async (tempDir) => {
@@ -1092,6 +1093,7 @@ const getOverlayDatabaseModeMacro = test.macro({
 
         t.deepEqual(result, {
           skippedDueToCachedStatus: false,
+          disabledByRepositoryProperty: false,
           ...expected,
         });
       } finally {
@@ -1938,6 +1940,7 @@ test(
   {
     overlayDatabaseMode: OverlayDatabaseMode.None,
     useOverlayDatabaseCaching: false,
+    disabledByRepositoryProperty: true,
   },
 );
 

src/config-utils.test.ts

@@ -760,10 +760,12 @@ export async function getOverlayDatabaseMode(
   overlayDatabaseMode: OverlayDatabaseMode;
   useOverlayDatabaseCaching: boolean;
   skippedDueToCachedStatus: boolean;
+  disabledByRepositoryProperty: boolean;
 }> {
   let overlayDatabaseMode = OverlayDatabaseMode.None;
   let useOverlayDatabaseCaching = false;
   let skippedDueToCachedStatus = false;
+  let disabledByRepositoryProperty = false;
 
   const modeEnv = process.env.CODEQL_OVERLAY_DATABASE_MODE;
   // Any unrecognized CODEQL_OVERLAY_DATABASE_MODE value will be ignored and
@@ -786,6 +788,7 @@ export async function getOverlayDatabaseMode(
         `because the ${RepositoryPropertyName.DISABLE_OVERLAY} repository property is set to true.`,
     );
     overlayDatabaseMode = OverlayDatabaseMode.None;
+    disabledByRepositoryProperty = true;
   } else if (
     await isOverlayAnalysisFeatureEnabled(
       features,
@@ -856,6 +859,7 @@ export async function getOverlayDatabaseMode(
     overlayDatabaseMode: OverlayDatabaseMode.None,
     useOverlayDatabaseCaching: false,
     skippedDueToCachedStatus,
+    disabledByRepositoryProperty,
   };
 
   if (overlayDatabaseMode === OverlayDatabaseMode.None) {
@@ -921,6 +925,7 @@ export async function getOverlayDatabaseMode(
     overlayDatabaseMode,
     useOverlayDatabaseCaching,
     skippedDueToCachedStatus,
+    disabledByRepositoryProperty,
   };
 }
 
@@ -1071,6 +1076,7 @@ export async function initConfig(
     overlayDatabaseMode,
     useOverlayDatabaseCaching,
     skippedDueToCachedStatus: overlaySkippedDueToCachedStatus,
+    disabledByRepositoryProperty: overlayDisabledByRepositoryProperty,
   } = await getOverlayDatabaseMode(
     inputs.codeql,
     inputs.features,
@@ -1119,6 +1125,31 @@ export async function initConfig(
     );
   }
 
+  if (overlayDisabledByRepositoryProperty) {
+    addNoLanguageDiagnostic(
+      config,
+      makeDiagnostic(
+        "codeql-action/overlay-disabled-by-repository-property",
+        "Improved incremental analysis disabled by repository property",
+        {
+          attributes: {
+            languages: config.languages,
+          },
+          markdownMessage:
+            "Improved incremental analysis has been disabled because the " +
+            `\`${RepositoryPropertyName.DISABLE_OVERLAY}\` repository property is set to \`true\`. ` +
+            "To re-enable improved incremental analysis, set this property to `false` or remove it.",
+          severity: "note",
+          visibility: {
+            cliSummaryTable: true,
+            statusPage: true,
+            telemetry: true,
+          },
+        },
+      ),
+    );
+  }
+
   if (
     overlayDatabaseMode === OverlayDatabaseMode.Overlay ||
     (await shouldPerformDiffInformedAnalysis(