From 15f944581b774ddeb09b87268a6e2315125e8637 Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Thu, 4 Sep 2025 13:18:31 +0100
Subject: [PATCH] Apply overrides from prepare artifact  (#2503)

---
 .github/workflows/build_linux.yaml   | 12 +++++++++++-
 .github/workflows/build_macos.yaml   | 11 ++++++++++-
 .github/workflows/build_prepare.yaml |  1 -
 .github/workflows/build_windows.yaml | 12 +++++++++++-
 4 files changed, 32 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/build_linux.yaml b/.github/workflows/build_linux.yaml
index a478ec8090..23d3b9aaf0 100644
--- a/.github/workflows/build_linux.yaml
+++ b/.github/workflows/build_linux.yaml
@@ -23,7 +23,17 @@ on:
             prepare-artifact-name:
                 type: string
                 required: false
-                description: "The name of the prepare artifact to use, defaults to 'webapp'"
+                description: |
+                    The name of the prepare artifact to use, defaults to 'webapp'.
+                    The artifact must contain the following:
+                    + webapp.asar - the asar archive of the webapp to embed in the desktop app
+                    + electronVersion - the version of electron to use for cache keying
+                    + hakHash - the hash of the .hak directory to use for cache keying
+                    + changelog.Debian - the changelog file to embed in the Debian package  
+                    + variant.json - the variant configuration to use for the build
+
+                    The artifact can also contain any additional files which will be applied as overrides to the checkout root before building,
+                    for example icons in the `build/` directory to override the app icons.
                 default: "webapp"
 env:
     SQLCIPHER_BUNDLED: ${{ inputs.sqlcipher == 'static' && '1' || '' }}
diff --git a/.github/workflows/build_macos.yaml b/.github/workflows/build_macos.yaml
index 892f585643..1a2799cbd8 100644
--- a/.github/workflows/build_macos.yaml
+++ b/.github/workflows/build_macos.yaml
@@ -34,7 +34,16 @@ on:
             prepare-artifact-name:
                 type: string
                 required: false
-                description: "The name of the prepare artifact to use, defaults to 'webapp'"
+                description: |
+                    The name of the prepare artifact to use, defaults to 'webapp'.
+                    The artifact must contain the following:
+                    + webapp.asar - the asar archive of the webapp to embed in the desktop app
+                    + electronVersion - the version of electron to use for cache keying
+                    + hakHash - the hash of the .hak directory to use for cache keying
+                    + variant.json - the variant configuration to use for the build
+
+                    The artifact can also contain any additional files which will be applied as overrides to the checkout root before building,
+                    for example icons in the `build/` directory to override the app icons.
                 default: "webapp"
 permissions: {} # No permissions required
 jobs:
diff --git a/.github/workflows/build_prepare.yaml b/.github/workflows/build_prepare.yaml
index 02fe91c4a9..8bb9f58f3d 100644
--- a/.github/workflows/build_prepare.yaml
+++ b/.github/workflows/build_prepare.yaml
@@ -171,7 +171,6 @@ jobs:
                   retention-days: 1
                   path: |
                       webapp.asar
-                      package.json
                       electronVersion
                       hakHash
                       changelog.Debian
diff --git a/.github/workflows/build_windows.yaml b/.github/workflows/build_windows.yaml
index cf63bd98b4..5749005e29 100644
--- a/.github/workflows/build_windows.yaml
+++ b/.github/workflows/build_windows.yaml
@@ -37,7 +37,17 @@ on:
             prepare-artifact-name:
                 type: string
                 required: false
-                description: "The name of the prepare artifact to use, defaults to 'webapp'"
+                description: |
+                    The name of the prepare artifact to use, defaults to 'webapp'.
+                    The artifact must contain the following:
+                    + webapp.asar - the asar archive of the webapp to embed in the desktop app
+                    + electronVersion - the version of electron to use for cache keying
+                    + hakHash - the hash of the .hak directory to use for cache keying
+                    + variant.json - the variant configuration to use for the build
+
+
+                    The artifact can also contain any additional files which will be applied as overrides to the checkout root before building,
+                    for example icons in the `build/` directory to override the app icons.
                 default: "webapp"
 permissions: {} # No permissions required
 jobs: