👷 Final Github Action tweaks & updates

Author: mkarlesky

.github/workflows/dev.yml

@@ -307,7 +307,7 @@ jobs:
           if-no-files-found: error
 
   # After all Docker image builds, collect results and publish a pre-release
-  artifacts-prerelease:
+  artifacts-dev-build:
     runs-on: ubuntu-latest
     needs:
       - madsciencelab
@@ -344,5 +344,5 @@ jobs:
           bodyFile: .github/workflows/release.md
           commit: ${{ github.sha }}
           tag: ${{ env.SHA_SHORT }}
-          name: Dev Build Prerelease-${{ env.SHA_SHORT }}
+          name: Dev Build ${{ env.SHA_SHORT }}
           artifacts: "artifacts/*/*.zip"

.github/workflows/release.md

@@ -1,14 +1,37 @@
 ## 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.
+Each build produces multiple variants of the `throwtheswitch/madsciencelab` Docker images containing Ceedling and its supporting frameworks as well as various utilities and compilation toolchains. Each image built from this repository targets multiple runtime 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.
+Build types (via Github Actions):
+
+1. A dev build of this repository generates files and validates the Docker image build.
+1. A release build adds to (1) by also pushing 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
+## Build Artifacts
 
 * 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.
+See this reository’s documentation for instructions on how to use the tools of this repository and how to manually build the Docker images this repository maintains.
+
+## Changelog
+
+### Added
+
+* ...
+
+### Fixed
+
+* ...
+
+### Changed
+
+* ...
+
+### Removed
+
+* ...
+
+

.github/workflows/release.yml

@@ -86,13 +86,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:
@@ -154,13 +156,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:
@@ -290,13 +296,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
 
   artifacts-release:
@@ -318,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
@@ -331,9 +339,10 @@ jobs:
 
       - uses: ncipollo/release-action@v1
         with:
-          # Defaults to using tag name.
+          # Defaults to using commit tag for `tag:`.
           # This workflow is only triggered by tags.
           prerelease: false
           allowUpdates: true
-          artifacts: "artifacts/**/Dockerfile,artifacts/**/welcome"
+          name: Release ${{ github.ref_name }}
+          artifacts: "artifacts/*/*.zip"