👷 Improved artifact generation + release body

Author: mkarlesky

.github/workflows/dev.yml

@@ -88,13 +88,15 @@ jobs:
           cache-from: type=gha
           cache-to: type=gha,mode=max
 
-      # Upload the generated files as artifacts 
+      # Zip generated files as a single artifact
+      - name: 'Archive ${{ env.IMAGE_NAME }} generated files as a single artifact'
+        run: zip -j ${{ env.IMAGE_NAME }}.zip ${{ env.IMAGE_DIR }}/docker/Dockerfile ${{ env.IMAGE_DIR }}/assets/shell/welcome
+
+      # Upload the zip artifact
       - uses: actions/upload-artifact@v4
         with:
           name: ${{ env.IMAGE_NAME }}
-          path: |
-            ${{ env.IMAGE_DIR }}/docker/Dockerfile
-            ${{ env.IMAGE_DIR }}/assets/shell/welcome
+          path: ${{ env.IMAGE_NAME }}.zip
           if-no-files-found: error
 
   madsciencelab-plugins:
@@ -155,13 +157,15 @@ jobs:
           cache-from: type=gha
           cache-to: type=gha,mode=max
 
-      # Upload the generated files as artifacts 
+      # Zip generated files as a single artifact
+      - name: 'Archive ${{ env.IMAGE_NAME }} generated files as a single artifact'
+        run: zip -j ${{ env.IMAGE_NAME }}.zip ${{ env.IMAGE_DIR }}/docker/Dockerfile ${{ env.IMAGE_DIR }}/assets/shell/welcome
+
+      # Upload the zip artifact
       - uses: actions/upload-artifact@v4
         with:
           name: ${{ env.IMAGE_NAME }}
-          path: |
-            ${{ env.IMAGE_DIR }}/docker/Dockerfile
-            ${{ env.IMAGE_DIR }}/assets/shell/welcome
+          path: ${{ env.IMAGE_NAME }}.zip
           if-no-files-found: error
 
   madsciencelab-arm-none-eabi:
@@ -222,13 +226,15 @@ jobs:
           cache-from: type=gha
           cache-to: type=gha,mode=max
 
-      # Upload the generated files as artifacts 
+      # Zip generated files as a single artifact
+      - name: 'Archive ${{ env.IMAGE_NAME }} generated files as a single artifact'
+        run: zip -j ${{ env.IMAGE_NAME }}.zip ${{ env.IMAGE_DIR }}/docker/Dockerfile ${{ env.IMAGE_DIR }}/assets/shell/welcome
+
+      # Upload the zip artifact
       - uses: actions/upload-artifact@v4
         with:
           name: ${{ env.IMAGE_NAME }}
-          path: |
-            ${{ env.IMAGE_DIR }}/docker/Dockerfile
-            ${{ env.IMAGE_DIR }}/assets/shell/welcome
+          path: ${{ env.IMAGE_NAME }}.zip
           if-no-files-found: error
 
   madsciencelab-arm-none-eabi-plugins:
@@ -289,15 +295,18 @@ jobs:
           cache-from: type=gha
           cache-to: type=gha,mode=max
 
-      # Upload the generated files as artifacts 
+      # Zip generated files as a single artifact
+      - name: 'Archive ${{ env.IMAGE_NAME }} generated files as a single artifact'
+        run: zip -j ${{ env.IMAGE_NAME }}.zip ${{ env.IMAGE_DIR }}/docker/Dockerfile ${{ env.IMAGE_DIR }}/assets/shell/welcome
+
+      # Upload the zip artifact
       - uses: actions/upload-artifact@v4
         with:
           name: ${{ env.IMAGE_NAME }}
-          path: |
-            ${{ env.IMAGE_DIR }}/docker/Dockerfile
-            ${{ env.IMAGE_DIR }}/assets/shell/welcome
+          path: ${{ env.IMAGE_NAME }}.zip
           if-no-files-found: error
 
+  # After all Docker image builds, collect results and publish a pre-release
   artifacts-prerelease:
     runs-on: ubuntu-latest
     needs:
@@ -317,7 +326,7 @@ jobs:
       - uses: actions/download-artifact@v4
         with:
           # `pattern:` is a workaround to an artifact upload incompatibility with docker/build-push-action@v6
-          # Otherwise, without `pattern:` the default of all artifacts would occur just as with this glob
+          # Otherwise, apart from this bug requiring `pattern:` the default of all artifacts would occur without any intervention
           # https://github.com/docker/build-push-action/issues/1167
           pattern: "madsciencelab*"
           path: artifacts
@@ -332,7 +341,8 @@ jobs:
         with:
           prerelease: true
           allowUpdates: true
+          bodyFile: .github/workflows/release.md
           commit: ${{ github.sha }}
           tag: ${{ env.SHA_SHORT }}
-          name: Prerelease-${{ env.SHA_SHORT }}
+          name: Dev Build Prerelease-${{ env.SHA_SHORT }}
           artifacts: "artifacts/**/Dockerfile,artifacts/**/welcome"

.github/workflows/release.md

@@ -0,0 +1,14 @@
+# MadScienceLab Docker Images Builds
+
+Each build produces multiple variants of the `madsciencelab` Docker images containing Ceedling and its supporting frameworks as well as various utilities and compilation toolchains. Each image targets multiple host platforms.
+
+A dev build of this repository in a Github Action generates files and validates the Docker image build. A release build also pushes the resulting Docker images to Docker hub.
+
+See the [Docker Hub repository](https://hub.docker.com/r/throwtheswitch) for official releases of the resulting Docker images and their documentation.
+
+# Contents
+
+* A zip archive for each Docker image containing the generated Dockerfile and any other generated file artifacts used to build the image in Docker Hub.
+* A zip archive of the entire project including the static assets used to build the Docker images.
+
+See this reository’s documentation for instructions on how to use the tools of this repository and how to build these Docker images.