From 6b9ae56dd1cfd2d18caa7d90eadcfcddaaed959f Mon Sep 17 00:00:00 2001
From: Marc Di Luzio <marc.diluzio@gmail.com>
Date: Fri, 16 Aug 2024 23:40:12 +0100
Subject: [PATCH] Clean up the workflow file

---
 .github/workflows/test-and-publish.yml | 22 +++++++++-------------
 1 file changed, 9 insertions(+), 13 deletions(-)

diff --git a/.github/workflows/test-and-publish.yml b/.github/workflows/test-and-publish.yml
index e89df20..7e65a17 100644
--- a/.github/workflows/test-and-publish.yml
+++ b/.github/workflows/test-and-publish.yml
@@ -1,4 +1,4 @@
-name: Run Tests
+name: Test, Build and Publish
 
 on:
   push:
@@ -9,14 +9,15 @@ on:
   pull_request:
   workflow_dispatch:
 
-# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
 env:
+  # Use the github container registry
   REGISTRY: ghcr.io
   IMAGE_NAME: ${{ github.repository }}
 
+  
 jobs:
 
-  # Core test runner
+  # Run the tests scripts
   test:
     runs-on: ubuntu-latest
     steps:
@@ -36,18 +37,17 @@ jobs:
       run: |
         python tests/test.py
 
-
+  # Build and push the docker images
   build-and-push-images:
     runs-on: ubuntu-latest
     needs: test
     
-    # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
     permissions:
       contents: read
       packages: write
       attestations: write
       id-token: write
-      # 
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -57,7 +57,6 @@ jobs:
         with:
           platforms: arm32v7/armhf # arm64v8/aarch64 - no current need for arm64
 
-      # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
       - name: Log in to the Container registry
         uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
         with:
@@ -65,12 +64,12 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
+      # Use docker-container driver for multi-platform builds
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
         with:
-          driver: docker-container  # Use docker-container driver for multi-platform builds
+          driver: docker-container  
 
-      # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
       - name: Extract metadata (tags, labels) for Docker
         id: meta
         uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
@@ -82,9 +81,6 @@ jobs:
             type=ref,event=pr
             type=edge,branch=main
 
-      # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
-      # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
-      # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
       - name: Build and push Docker image
         id: push
         uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
@@ -94,10 +90,10 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          # Cache to help the step run a little faster
           cache-from: type=gha
           cache-to: type=gha,mode=max
       
-      # This step generates an artifact attestation for the image, which is an unforgeable statement about where and how it was built. It increases supply chain security for people who consume the image. For more information, see "[AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds)." 
       - name: Generate artifact attestation
         uses: actions/attest-build-provenance@v1
         with: