Reconciling changes from ubi, jammy and noble (#10)

pacostas · web-flow · commit 186ec90604bd · 2025-05-16T16:12:14.000+02:00
* adding capability of using image instead of stack naming on the assets

* fix: push image workflow

* feat: adding more control over the naming of the assets

* fix: adding more control over naming

fix: adding missing bracket

fix: typo

fix: typo

fix: typo

fix: wrong path

refactor: for loop for each asset

debug code remove me

fix: typo on tag prefix

fix: push image workflow

* fix: excluding copying file if default stack is not found

* fix: proper naming for the 3rd option on asset_pattern
diff --git a/.github/workflows/create-release.yml b/.github/workflows/create-release.yml
diff --git a/.github/workflows/push-image.yml b/.github/workflows/push-image.yml
@@ -13,7 +13,7 @@ on:
 
 env:
   REGISTRIES_FILEPATH: "registries.json"
-  STACKS_FILEPATH: "stacks/images.json"
+  STACKS_FILEPATH: "images.json"
   GCR_REGISTRY: "gcr.io"
   GCR_USERNAME: "_json_key"
 
@@ -27,6 +27,10 @@ jobs:
       push_to_gcr: ${{ steps.parse_configs.outputs.push_to_gcr }}
       push_to_dockerhub: ${{ steps.parse_configs.outputs.push_to_dockerhub }}
       tag: ${{ steps.event.outputs.tag }}
+      os_codename: ${{ steps.repo.outputs.os_codename }}
+      os_name: ${{ steps.repo.outputs.os_name }}
+      repo_type: ${{ steps.repo.outputs.repo_type }}
+      stacks: ${{ steps.get-stacks.outputs.stacks }}
     steps:
     - name: Checkout
       uses: actions/checkout@v4
@@ -47,39 +51,116 @@ jobs:
     - name: Set matrix
       id: set-matrix
       run: |
-        release_version="${{ steps.event.outputs.tag }}"
-        release_info=$(curl -s "https://api.github.com/repos/${{ github.repository }}/releases/tags/v${release_version}")
-        oci_release_assets=$(echo $release_info | jq -c --arg asset_prefix "$asset_prefix" '[ .assets[] | select(.name | endswith(".oci")) | {name: (.name | split(".oci") | .[0]), url}]' | jq -c '.[]')
-
-        matrix=$(jq -n -c '[]')
+        stacks=$(jq -c '.images | .[]' ${STACKS_FILEPATH})
+        version="${{ steps.event.outputs.tag }}"
+        os_name=$( jq -r '.os_name' ${STACKS_FILEPATH} )
+        os_codename=$( jq -r '.os_codename' ${STACKS_FILEPATH} )
+        repo_type=$( jq -r '.repo_type' ${STACKS_FILEPATH} )
+
+        # Start with an empty array
+        asset_names=$(jq -n -c '[]')
+
+        for stack in $stacks; do
+          stack_name=$(echo "$stack" | jq -r '.name')
+          stack_type=$(echo "$stack" | jq -r '.stack_type // ""')
+
+          # .oci artifacts for the run image
+          run_image=$(echo "$stack" | jq -r '.run_image')
+          build_image=$(echo "$stack" | jq -r '.build_image')
+
+          if [ $pattern_assets_prefix == "os_codename-stack_type-repo_type" ]; then
+            asset_prefix="${os_codename}-${stack_type}-${repo_type}"
+          elif [ $pattern_assets_prefix == "os_codename-repo_type" ]; then
+            asset_prefix="${os_codename}-${repo_type}"
+          fi
 
-        if [ -f ${{ env.STACKS_FILEPATH }} ]; then
-          pattern_image_registry_name=$(jq '.pattern_image_registry_name' ${{ env.STACKS_FILEPATH }})
-          os_name=$(jq -r '.os_name' ${{ env.STACKS_FILEPATH }})
-        else
-          pattern_image_registry_name="build_image_run_image-os_codename-stack_type"
-        fi
+          pattern_assets_prefix=$(echo "$stack" | jq -r '.pattern_assets_prefix // ""')
+          if [[ "$pattern_assets_prefix" == "os_name-os_codename-build_image_run_image-stack_type-version-arch" ]]; then
+            run_image_asset_prefix="${os_name}-${os_codename}-${run_image}-${stack_type}-${version}"
+            build_image_asset_prefix="${os_name}-${os_codename}-${build_image}-${stack_type}-${version}"
+          elif [[ "$pattern_assets_prefix" == "os_name-os_codename-build_image_run_image-version-arch" ]]; then
+            run_image_asset_prefix="${os_name}-${os_codename}-${run_image}-${version}"
+            build_image_asset_prefix="${os_name}-${os_codename}-${build_image}-${version}"
+          elif [[ "$pattern_assets_prefix" == "os_codename-stack_type-repo_type-version-arch-build_image_run_image" ]]; then
+            run_image_asset_prefix="${os_codename}-${stack_type}-${repo_type}-${version}-${run_image}"
+            build_image_asset_prefix="${os_codename}-${stack_type}-${repo_type}-${version}-${build_image}"
+          fi
 
-        for oci_asset in $oci_release_assets; do
-          oci_asset_name=$(echo $oci_asset | jq -r '.name')
-          oci_asset_url=$(echo $oci_asset | jq -r '.url')
-          os_codename=$(echo $oci_asset | jq -r '.name' | cut -d '-' -f 1)
-          stack_type=$(echo $oci_asset | jq -r '.name' | cut -d '-' -f 2)
-          build_or_run_image_name=$(echo $oci_asset | jq -r '.name' | cut -d '-' -f 5- | cut -d '.' -f 1)
-
-          if [ $pattern_image_registry_name == "build_image_run_image-os_codename-stack_type" ]; then
-            image_registry_name="${build_or_run_image_name}-${os_codename}-${stack_type}"
-          else
-            image_registry_name="${os_name}-${os_codename}-${build_or_run_image_name}-${stack_type}"
+          pattern_image_registry_name=$(echo "$stack" | jq -r '.pattern_image_registry_name // ""')
+          if [ $pattern_image_registry_name == "os_name-os_codename-build_image_run_image-stack_type" ]; then
+            build_image_registry_name="${os_name}-${os_codename}-${build_image}-${stack_type}"
+            run_image_registry_name="${os_name}-${os_codename}-${run_image}-${stack_type}"
+          elif [ $pattern_image_registry_name == "os_name-os_codename-build_image_run_image" ]; then
+            build_image_registry_name="${os_name}-${os_codename}-${build_image}"
+            run_image_registry_name="${os_name}-${os_codename}-${run_image}"
+          elif [ $pattern_image_registry_name == "build_image_run_image-os_codename-stack_type" ]; then
+            build_image_registry_name="${build_image}-${os_codename}-${stack_type}"
+            run_image_registry_name="${run_image}-${os_codename}-${stack_type}"
           fi
 
-          matrix=$(echo $matrix | jq -c --arg os_codename "$os_codename" \
-            --arg oci_asset_name "$oci_asset_name" \
-            --arg registry_name "$image_registry_name" \
-            --arg oci_asset_url "$oci_asset_url" \
-            '. + [{name: $oci_asset_name, registry_name: $registry_name, oci_asset_url: $oci_asset_url}]')
+          asset_names="$(jq -c \
+          --arg image_filepath "image-files" \
+          --arg stack_name "${stack_name}" \
+          --arg run_image_asset_prefix "${run_image_asset_prefix}" \
+          --arg run_image_registry_name "${run_image_registry_name}" \
+          '. += [
+              {
+                "name": $run_image_asset_prefix,
+                "path": ($image_filepath + "/" + "current-run-image-" + $stack_name + "/run" + ".oci"),
+                "registry_name": $run_image_registry_name
+              }
+            ]' <<<"${asset_names}")"
+
+          # .oci artifacts for the build image
+          create_build_image=$(echo "$stack" | jq -r '.create_build_image // false')
+          if [[ $create_build_image == true ]]; then
+
+            asset_names="$(jq -c \
+              --arg image_filepath "image-files" \
+              --arg stack_name "${stack_name}" \
+              --arg build_image_asset_prefix "${build_image_asset_prefix}" \
+              --arg build_image_registry_name "${build_image_registry_name}" \
+              '. += [
+                  {
+                    "name": $build_image_asset_prefix,
+                    "path": ($image_filepath + "/" + "current-build-image-" + $stack_name + "/build" + ".oci"),
+                    "registry_name": $build_image_registry_name
+
+                  }
+                ]' <<<"${asset_names}")"
+          fi
         done
 
+        release_version="${{ steps.event.outputs.tag }}"
+        release_info=$(curl -s "https://api.github.com/repos/${{ github.repository }}/releases/tags/v${release_version}")
+        oci_release_assets=$(echo "$release_info" | jq -c \
+          '[ .assets[]
+            | select(.name | endswith(".oci"))
+            | {name: (.name | split(".oci") | .[0]), oci_asset_url: .url}
+          ]')
+
+        oci_release_assets_length=$(echo "$oci_release_assets" | jq 'length')
+        asset_names_length=$(echo "$asset_names" | jq 'length')
+
+        if [ "$oci_release_assets_length" != "$asset_names_length" ]; then
+          echo "Produced assets do not match the release assets."
+          exit 1
+        fi
+
+        matrix=$(jq -n -c --argjson a "$oci_release_assets" --argjson b "$asset_names" '
+          $a | map(
+            . as $oci_item
+            | ($b[] | select(.name == $oci_item.name)) as $asset_item
+            | $oci_item + $asset_item
+          )
+        ')
+
+        matrix_length=$(echo "$matrix" | jq 'length')
+        if [ "$matrix_length" != "$asset_names_length" ]; then
+          echo "Produced assets do not match the release assets."
+          exit 1
+        fi
+
         echo "matrix=${matrix}"
         echo "matrix=${matrix}" >> "$GITHUB_OUTPUT"
 
diff --git a/images.json b/images.json
@@ -0,0 +1,43 @@
+{
+  "support_usns": true,
+  "receipts_show_limit": 16,
+  "platforms": ["linux/amd64", "linux/arm64"],
+  "os_name": "ubuntu",
+  "os_codename": "noble",
+  "repo_type": "image",
+  "images": [
+    {
+      "name": "noble-tiny",
+      "config_dir": "stacks/noble-tiny-stack",
+      "output_dir": "builds/noble-tiny-stack",
+      "build_image": "build",
+      "run_image": "run",
+      "stack_type": "tiny",
+      "pattern_image_registry_name": "os_name-os_codename-build_image_run_image-stack_type",
+      "pattern_assets_prefix": "os_name-os_codename-build_image_run_image-stack_type-version-arch"
+    },
+    {
+      "name": "noble-static",
+      "config_dir": "stacks/noble-static-stack",
+      "output_dir": "builds/noble-static-stack",
+      "build_image": "build",
+      "run_image": "run",
+      "build_receipt_filename": "build-receipt.cyclonedx.json",
+      "run_receipt_filename": "run-receipt.cyclonedx.json",
+      "stack_type": "static",
+      "pattern_image_registry_name": "os_name-os_codename-build_image_run_image-stack_type",
+      "pattern_assets_prefix": "os_name-os_codename-build_image_run_image-stack_type-version-arch"
+    },
+    {
+      "name": "noble-base",
+      "config_dir": "stacks/noble-base-stack",
+      "output_dir": "builds/noble-base-stack",
+      "build_image": "build",
+      "run_image": "run",
+      "create_build_image": true,
+      "stack_type": "base",
+      "pattern_image_registry_name": "os_name-os_codename-build_image_run_image",
+      "pattern_assets_prefix": "os_name-os_codename-build_image_run_image-version-arch"
+    }
+  ]
+}
diff --git a/scripts/create.sh b/scripts/create.sh
@@ -6,7 +6,7 @@ set -o pipefail
 readonly PROG_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 readonly ROOT_DIR="$(cd "${PROG_DIR}/.." && pwd)"
 readonly BIN_DIR="${ROOT_DIR}/.bin"
-readonly IMAGES_JSON="${ROOT_DIR}/stacks/images.json"
+readonly IMAGES_JSON="${ROOT_DIR}/images.json"
 
 # shellcheck source=SCRIPTDIR/.util/tools.sh
 source "${PROG_DIR}/.util/tools.sh"
@@ -67,7 +67,9 @@ function main() {
   if [ -f "${IMAGES_JSON}" ]; then
     # we need to copy images.json for inclusion in the build image
     defaultStackPath=$(jq -r '.images[] | select(.name == "default") | .config_dir' "${IMAGES_JSON}")
-    cp $IMAGES_JSON $ROOT_DIR/$defaultStackPath/images.json
+    if [ -n "$defaultStackPath" ]; then
+      cp $IMAGES_JSON "${ROOT_DIR}/${defaultStackPath}/images.json"
+    fi
   fi
 
   # if stack or build argument is provided but not both, then throw an error
diff --git a/scripts/receipts.sh b/scripts/receipts.sh
@@ -152,11 +152,7 @@ function receipts::generate::multi::arch() {
         fileName=$(basename ${runOutput})
       fi
 
-      if [ $imageArch = "amd64" ]; then
-        imageReceipt="${dir}/${fileName}"
-      else
-        imageReceipt="${dir}/${imageArch}-${fileName}"
-      fi
+      imageReceipt="${dir}/${imageArch}-${fileName}"
 
       util::print::info "Generating CycloneDX package SBOM using syft for $archiveName on platform linux/$imageArch saved as $imageReceipt"
 
diff --git a/stacks/images.json b/stacks/images.json
@@ -1,21 +1,20 @@
 {
   "support_usns": true,
-  "update_on_new_image": true,
   "receipts_show_limit": 16,
   "platforms": ["linux/amd64", "linux/arm64"],
   "os_name": "ubuntu",
   "os_codename": "noble",
-  "pattern_image_registry_name": "os-os_codename-build_image_run_image-stack_type",
+  "repo_type": "image",
   "images": [
     {
       "name": "noble-tiny",
       "config_dir": "stacks/noble-tiny-stack",
       "output_dir": "builds/noble-tiny-stack",
       "build_image": "build",
       "run_image": "run",
-      "build_receipt_filename": "build-receipt.cyclonedx.json",
-      "run_receipt_filename": "run-receipt.cyclonedx.json",
-      "stack_type": "tiny"
+      "stack_type": "tiny",
+      "pattern_image_registry_name": "os_name-os_codename-build_image_run_image-stack_type",
+      "pattern_assets_prefix": "os_name-os_codename-build_image_run_image-stack_type-version-arch"
     },
     {
       "name": "noble-static",
@@ -25,18 +24,20 @@
       "run_image": "run",
       "build_receipt_filename": "build-receipt.cyclonedx.json",
       "run_receipt_filename": "run-receipt.cyclonedx.json",
-      "stack_type": "static"
+      "stack_type": "static",
+      "pattern_image_registry_name": "os_name-os_codename-build_image_run_image-stack_type",
+      "pattern_assets_prefix": "os_name-os_codename-build_image_run_image-stack_type-version-arch"
     },
     {
       "name": "noble-base",
       "config_dir": "stacks/noble-base-stack",
       "output_dir": "builds/noble-base-stack",
       "build_image": "build",
       "run_image": "run",
-      "build_receipt_filename": "build-receipt.cyclonedx.json",
-      "run_receipt_filename": "run-receipt.cyclonedx.json",
       "create_build_image": true,
-      "stack_type": "base"
+      "stack_type": "base",
+      "pattern_image_registry_name": "os_name-os_codename-build_image_run_image",
+      "pattern_assets_prefix": "os_name-os_codename-build_image_run_image-version-arch"
     }
   ]
 }
