From deafb9f60752aa89a39d5f5f272d52ce073a06a7 Mon Sep 17 00:00:00 2001
From: dwasint <82520990+dwasint@users.noreply.github.com>
Date: Tue, 25 Jul 2023 15:03:03 -0400
Subject: [PATCH] Update ci_suite.yml

---
 .github/workflows/ci_suite.yml | 35 ++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/.github/workflows/ci_suite.yml b/.github/workflows/ci_suite.yml
index 5443ec6e49ea..b5ed61226f2f 100644
--- a/.github/workflows/ci_suite.yml
+++ b/.github/workflows/ci_suite.yml
@@ -169,6 +169,41 @@ jobs:
     steps:
       - run: echo Alternate tests passed.
 
+  compare_screenshots:
+    if: "!contains(github.event.head_commit.message, '[ci skip]') && (success() || failure())"
+    needs: [run_all_tests, run_alternate_tests]
+    name: Compare Screenshot Tests
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+      # If we ever add more artifacts, this is going to break, but it'll be obvious.
+      - name: Download screenshot tests
+        uses: actions/download-artifact@v3
+        with:
+          path: artifacts
+      - name: ls -R
+        run: ls -R artifacts
+      - name: Setup screenshot comparison
+        run: npm i
+        working-directory: tools/screenshot-test-comparison
+      - name: Run screenshot comparison
+        run: node tools/screenshot-test-comparison/index.js artifacts code/modules/unit_tests/screenshots artifacts/screenshot_comparisons
+      # workflow_run does not give you the PR it ran on,
+      # even through the thing literally named "matching pull requests".
+      # However, in GraphQL, you can check if the check suite was ran
+      # by a specific PR, so trusting the (user controlled) action here is okay,
+      # as long as we check it later in show_screenshot_test_results
+      - name: Save PR ID
+        if: failure() && github.event.pull_request
+        run: |
+          echo ${{ github.event.pull_request.number }} > artifacts/screenshot_comparisons/pull_request_number.txt
+      - name: Upload bad screenshots
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: bad-screenshots
+          path: artifacts/screenshot_comparisons
+
   test_windows:
     if: "!contains(github.event.head_commit.message, '[ci skip]')"
     name: Windows Build