ci: add gh cache to nix action (#87)

ThomasK33 · web-flow · commit ae51d0eb45f9 · 2025-03-04T07:29:03.000+01:00
Improves GitHub Actions environments and caching, reducing the Nix installation and store setup time from approximately 2 minutes to around 1 minute.

- Switches to nixbuild/nix-quick-install-action for Nix setup
- Implements Nix cache management with nix-community/cache-nix-action
- Creates separate CI devshell with minimal dependencies
- Makes version variables in Makefile overridable
- Adds .ignore file for search tool configuration

Change-Id: Ie564f9efc86b64f2582a2fdbf395a6dba84c3c81
Signed-off-by: Thomas Kosiewski &lt;tk@coder.com&gt;
diff --git a/.github/actions/nix-devshell/action.yaml b/.github/actions/nix-devshell/action.yaml
@@ -4,7 +4,28 @@ runs:
   using: "composite"
   steps:
     - name: Setup Nix
-      uses: DeterminateSystems/nix-installer-action@e50d5f73bfe71c2dd0aa4218de8f4afa59f8f81d # v16
+      uses: nixbuild/nix-quick-install-action@5bb6a3b3abe66fd09bbf250dce8ada94f856a703 # v30
+
+    - uses: nix-community/cache-nix-action@92aaf15ec4f2857ffed00023aecb6504bb4a5d3d # v6
+      with:
+        # restore and save a cache using this key
+        primary-key: nix-${{ runner.os }}-${{ hashFiles('**/*.nix', '**/flake.lock') }}
+        # if there's no cache hit, restore a cache by this prefix
+        restore-prefixes-first-match: nix-${{ runner.os }}-
+        # collect garbage until Nix store size (in bytes) is at most this number
+        # before trying to save a new cache
+        # 1 GB = 1073741824 B
+        gc-max-store-size-linux: 1073741824
+        # do purge caches
+        purge: true
+        # purge all versions of the cache
+        purge-prefixes: nix-${{ runner.os }}-
+        # created more than this number of seconds ago relative to the start of the `Post Restore` phase
+        purge-created: 0
+        # except the version with the `primary-key`, if it exists
+        purge-primary-key: never
 
     - name: Enter devshell
       uses: nicknovitski/nix-develop@9be7cfb4b10451d3390a75dc18ad0465bed4932a # v1.2.1
+      with:
+        arguments: ".#ci"
diff --git a/.ignore b/.ignore
@@ -0,0 +1 @@
+!.github
diff --git a/Makefile b/Makefile
@@ -11,14 +11,18 @@ XCPROJECT := Coder\ Desktop/Coder\ Desktop.xcodeproj
 SCHEME := Coder\ Desktop
 SWIFT_VERSION := 6.0
 
-CURRENT_PROJECT_VERSION:=$(shell git describe --match 'v[0-9]*' --dirty='.devel' --always --tags)
+ifndef CURRENT_PROJECT_VERSION
+	CURRENT_PROJECT_VERSION:=$(shell git describe --match 'v[0-9]*' --dirty='.devel' --always --tags)
+endif
 ifeq ($(strip $(CURRENT_PROJECT_VERSION)),)
-    $(error CURRENT_PROJECT_VERSION cannot be empty)
+	$(error CURRENT_PROJECT_VERSION cannot be empty)
 endif
 
-MARKETING_VERSION:=$(shell git describe --match 'v[0-9]*' --tags --abbrev=0 | sed 's/^v//' | sed 's/-.*$$//')
+ifndef MARKETING_VERSION
+	MARKETING_VERSION:=$(shell git describe --match 'v[0-9]*' --tags --abbrev=0 | sed 's/^v//' | sed 's/-.*$$//')
+endif
 ifeq ($(strip $(MARKETING_VERSION)),)
-    $(error MARKETING_VERSION cannot be empty)
+	$(error MARKETING_VERSION cannot be empty)
 endif
 
 # Define the keychain file name first
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -53,26 +53,38 @@
         {
           inherit formatter;
 
-          devShells.default = pkgs.mkShellNoCC {
-            buildInputs = with pkgs; [
-              actionlint
-              apple-sdk_15
-              clang
-              coreutils
-              create-dmg
-              formatter
-              gh
-              gnumake
-              protobuf_28
-              protoc-gen-swift
-              swiftformat
-              swiftlint
-              watchexec
-              xcbeautify
-              xcodegen
-              xcpretty
-              zizmor
-            ];
+          devShells = rec {
+            # Need to use a devshell for CI, as we want to reuse the already existing Xcode on the runner
+            ci = pkgs.mkShellNoCC {
+              buildInputs = with pkgs; [
+                actionlint
+                clang
+                coreutils
+                create-dmg
+                gh
+                git
+                gnumake
+                protobuf_28
+                protoc-gen-swift
+                swiftformat
+                swiftlint
+                xcbeautify
+                xcodegen
+                xcpretty
+                zizmor
+              ];
+            };
+
+            default = pkgs.mkShellNoCC {
+              buildInputs =
+                with pkgs;
+                [
+                  apple-sdk_15
+                  formatter
+                  watchexec
+                ]
+                ++ ci.buildInputs;
+            };
           };
         }
       );
