Verify documentation images are not stale on CI

gunndabad · Dec 9, 2022 · a34140d · a34140d
1 parent 42817a5
commit a34140d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -57,6 +57,15 @@ jobs:
         dotnet test test/GovUk.Frontend.AspNetCore.ConformanceTests/ --configuration Release --no-build
         dotnet test test/GovUk.Frontend.AspNetCore.IntegrationTests/ --configuration Release --no-build
 
+    - name: Check documentation images
+      run:
+        DOCS_ROOT=$(realpath docs/images) dotnet run --project src/GovUk.Frontend.AspNetCore.DocSamplesScreenshotter
+
+        git diff --cached --quiet docs/images || (
+          echo "::error ::Documentation images are stale"
+          exit 1
+        )
+
     - name: Package
       run: dotnet pack src/GovUk.Frontend.AspNetCore/ --configuration Release --no-build
       env:

diff --git a/src/GovUk.Frontend.AspNetCore.DocSamplesScreenshotter/Program.cs b/src/GovUk.Frontend.AspNetCore.DocSamplesScreenshotter/Program.cs
@@ -16,7 +16,7 @@ class Program
         static async Task Main()
         {
             const string baseUrl = "http://localhost:9919";
-            const string docsRoot = "../../../../../docs/images/";
+            string docsRoot = Environment.GetEnvironmentVariable("DOCS_ROOT") ?? "../../../../../docs/images/";
 
             var hostBuilder = CreateHostBuilder();
             using var host = hostBuilder.Build();