From 85af93e64fea9a40d71bb0c45aa4472aaf928fc0 Mon Sep 17 00:00:00 2001
From: Elliott Sales de Andrade <quantum.analyst@gmail.com>
Date: Wed, 29 Mar 2023 04:11:06 -0400
Subject: [PATCH] Add image diffs against previous build to CI results

---
 .github/workflows/main.yaml | 12 +++++++++
 Makefile                    |  1 +
 check-diffs.py              | 51 +++++++++++++++++++++++++++++++++++++
 3 files changed, 64 insertions(+)
 create mode 100755 check-diffs.py

diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml
index 1270699..8c50ad0 100644
--- a/.github/workflows/main.yaml
+++ b/.github/workflows/main.yaml
@@ -62,6 +62,18 @@ jobs:
             cheatsheets.pdf
             handout-*.pdf
             ./docs/_build/html/
+      - uses: actions/upload-artifact@v4
+        id: diffs-artifact-upload
+        if: ${{ always() }}
+        with:
+          name: diffs
+          path: |
+            diffs/
+      - name: Output artifacts URL
+        run: |
+          echo 'Artifact URL:' \
+            '${{ steps.diffs-artifact-upload.outputs.artifact-url }}' \
+            >> $GITHUB_STEP_SUMMARY
       - name: Publish cheatsheets and handouts
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
         uses: peaceiris/actions-gh-pages@v3
diff --git a/Makefile b/Makefile
index 555ef60..4e0ef4c 100644
--- a/Makefile
+++ b/Makefile
@@ -51,6 +51,7 @@ check:
 	./check-num-pages.sh handout-beginner.pdf 1
 	./check-num-pages.sh handout-intermediate.pdf 1
 	./check-links.py cheatsheets.pdf
+	./check-diffs.py
 
 .PHONY: docs
 docs:
diff --git a/check-diffs.py b/check-diffs.py
new file mode 100755
index 0000000..e68c0d6
--- /dev/null
+++ b/check-diffs.py
@@ -0,0 +1,51 @@
+#!/usr/bin/env python
+
+import os
+import subprocess
+import sys
+from pathlib import Path
+
+
+ROOT_DIR = Path(__file__).parent
+
+if os.environ.get('GITHUB_ACTIONS', '') == '':
+    print('Not running when not in GitHub Actions.')
+    sys.exit()
+summary_file = os.environ.get('GITHUB_STEP_SUMMARY')
+if summary_file is None:
+    sys.exit('$GITHUB_STEP_SUMMARY is not set')
+
+gh_pages = ROOT_DIR.parent / 'pages'
+subprocess.run(['git', 'fetch', 'https://github.com/matplotlib/cheatsheets.git',
+                'gh-pages:upstream-gh-pages'], check=True)
+subprocess.run(['git', 'worktree', 'add', gh_pages, 'upstream-gh-pages'],
+               check=True)
+
+diff_dir = ROOT_DIR / 'diffs'
+diff_dir.mkdir(exist_ok=True)
+
+hashes = {}
+for original in gh_pages.glob('*.png'):
+    result = subprocess.run(
+        ['compare', '-metric', 'PHASH',
+         original,
+         ROOT_DIR / 'docs/_build/html' / original.name,
+         diff_dir / f'{original.stem}-diff.png'],
+        text=True, stderr=subprocess.PIPE)
+    if result.returncode == 2:  # Some kind of IO or similar error.
+        hashes[original] = (float('nan'), result.stderr)
+    elif result.stderr:  # Images were different.
+        hashes[original] = (float(result.stderr), '')
+    else:  # No differences.
+        hashes[original] = (0.0, '')
+
+with open(summary_file, 'w+') as summary:
+    print('# Cheatsheet image comparison', file=summary)
+    print('| Filename | Perceptual Hash Difference | Error message |', file=summary)
+    print('| -------- | -------------------------- | ------------- |', file=summary)
+    for filename, (hash, message) in sorted(hashes.items()):
+        message = message.replace('\n', ' ').replace('|', '\\|')
+        print(f'| {filename.name} | {hash:.05f} | {message}', file=summary)
+    print(file=summary)
+
+subprocess.run(['git', 'worktree', 'remove', gh_pages])