From fff33d50446bf371f55087363ebb2e341370980e Mon Sep 17 00:00:00 2001
From: NAHO <90870942+trueNAHO@users.noreply.github.com>
Date: Sun, 5 Jan 2025 22:06:20 +0100
Subject: [PATCH] ci: optimize CI time by running only relevant checks

Significantly optimize the CI time by running only the relevant checks
based on the changed files.

The lightweight and compatible implementation for getting the changed
files is adapted from [1].

[1]: https://stackoverflow.com/questions/74265821
---
 .github/workflows/check.yml | 110 +++++++++++++++++++++++++++---------
 1 file changed, 84 insertions(+), 26 deletions(-)

diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
index d8826d4..a64b820 100644
--- a/.github/workflows/check.yml
+++ b/.github/workflows/check.yml
@@ -12,6 +12,10 @@ jobs:
     runs-on: ubuntu-24.04
 
     steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: ${{ github.event_name == 'pull_request' && 2 || 0 }}
+
       - uses: DeterminateSystems/nix-installer-action@v16
       - uses: DeterminateSystems/magic-nix-cache-action@v8
 
@@ -23,32 +27,86 @@ jobs:
             }}/${{
               github.event.pull_request.head.sha || github.sha
             }} |
-            jq --raw-output '
-              def format_output($arch; $type):
-                {
-                  arch: $arch,
-                  key: .,
-
-                  os: (
-                    if $arch == "x86_64-linux" then
-                      "ubuntu-24.04"
-                    else
-                      "macos-14"
-                    end
-                  ),
-
-                  type: $type
-                };
-
-              [
-                ["x86_64-linux", "x86_64-darwin"][] as $arch |
-                (.checks[$arch] | keys) as $checks |
-                (.packages[$arch] | keys) as $packages |
-                (($checks - $packages)[] | format_output($arch; "checks")),
-                ($packages[] | format_output($arch; "packages"))
-              ] |
-              "derivations=\(.)"
-            ' >>$GITHUB_OUTPUT
+            jq \
+              --argjson changed_files "$(
+                if ${{ github.event_name == 'pull_request' }}; then
+                  git diff --name-only HEAD~1 HEAD
+                else
+                  git diff --name-only \
+                    ${{ github.event.before }} ${{ github.event.after }}
+                fi |
+                  jq --raw-input --raw-output --slurp 'split("\n")[:-1]'
+              )" \
+              --raw-output \
+              '
+                def format_output($arch; $type):
+                  {
+                    arch: $arch,
+                    key: .,
+                    os: (
+                      if $arch == "x86_64-linux" then
+                        "ubuntu-24.04"
+                      else
+                        "macos-14"
+                      end
+                    ),
+                    type: $type
+                  };
+
+                [
+                  ["x86_64-linux", "x86_64-darwin"][] as $arch |
+                  (.checks[$arch] | keys) as $checks |
+                  (.packages[$arch] | keys) as $packages |
+                  (($checks - $packages)[] | format_output($arch; "checks")),
+                  ($packages[] | format_output($arch; "packages"))
+                ] as $derivations |
+
+                # Keep everything when touching critical files.
+                if (
+                  $changed_files |
+                  any(
+                    . == "flake.lock" or (. | startswith(".github/workflows/"))
+                  )
+                ) then
+                  $derivations
+
+                else
+                  $derivations |
+                  map(
+                    select(
+                      if .key == "nix-flake-check" then
+                        ($changed_files | any(. == "flake.nix"))
+
+                      elif .key == "docs" then
+                        ($changed_files | any(startswith("docs/")))
+
+                      elif .key == "palette-generator" then
+                        ($changed_files | any(startswith("palette-generator/")))
+
+                      elif (.key | test("^testbed-[^-]+-")) then
+                        (
+                          .key | capture("^testbed-(?<module>[^-]+)") | .module
+                        ) as $module |
+                        (
+                          $changed_files |
+                          any(startswith("modules/\($module)/"))
+                        )
+
+                      # Always keep the git-hooks derivation.
+                      elif .key == "git-hooks" then
+                        true
+
+                      else
+                        error(
+                          "Derivation must be handled or explicitly ignored: " +
+                          .key
+                        )
+                      end
+                    )
+                  )
+                end |
+                "derivations=\(.)"
+              ' >>$GITHUB_OUTPUT
 
     outputs:
       derivations: ${{ steps.get-derivations.outputs.derivations }}