Improve comments

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

Author: t3chguy

.github/workflows/build_linux.yaml

@@ -23,7 +23,18 @@ 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
+                    + package.json - the package.json to use for build metadata
+                    + 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:
+                    + overrides/ - an optional directory containing any file/directory overrides to apply to the checkout root before building
                 default: "webapp"
 env:
     SQLCIPHER_BUNDLED: ${{ inputs.sqlcipher == 'static' && '1' || '' }}

.github/workflows/build_macos.yaml

@@ -34,7 +34,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
+                    + package.json - the package.json to use for build metadata
+                    + 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:
+                    + overrides/ - an optional directory containing any file/directory overrides to apply to the checkout root before building
                 default: "webapp"
 permissions: {} # No permissions required
 jobs:

.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
+                    + package.json - the package.json to use for build metadata
+                    + 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:
+                    + overrides/ - an optional directory containing any file/directory overrides to apply to the checkout root before building
                 default: "webapp"
 permissions: {} # No permissions required
 jobs: