feat(cicd): Implement fallback logic for missing component artifacts and enhance version reporting

XargonWan · XargonWan · commit 5669489242f8 · 2025-12-26T09:44:09.000+09:00
diff --git a/.github/workflows/build_components.yml b/.github/workflows/build_components.yml
@@ -198,7 +198,7 @@ jobs:
     needs: [build-light, build-heavy]
     runs-on: ubuntu-latest
     if: always() && (github.event_name != 'schedule' || github.ref == 'refs/heads/update/components')
-    continue-on-error: true
+    continue-on-error: ${{ github.ref != 'refs/heads/main' }}
     steps:
 
       # Clone Repository (pull_request_target)
@@ -231,7 +231,60 @@ jobs:
             fi
           done
 
+      - name: Generate a token for Rekku
+        id: generate-rekku-token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ vars.REKKU_APP_ID }}
+          private-key: ${{ secrets.REKKU_PRIVATE_KEY }}
+          repositories: "components"
+          owner: "RetroDECK"
+
+      # This will generate desired_versions.sh based on the current state of the components
+      # Useful to "lock" the versions in future builds or to bring it to main (manually)
+      - name: Generate desired_versions.sh (snapshot)
+        env:
+          GITHUB_TOKEN: ${{ steps.generate-rekku-token.outputs.token }}
+        run: |
+          set -e
+          automation-tools/alchemist/generate_desired_versions.sh -f automation-tools/alchemist/desired_versions.sh
+          latest_generated="$(ls -1t automation-tools/alchemist/desired_versions_*.sh | head -n 1)"
+          if [ -z "$latest_generated" ] || [ ! -f "$latest_generated" ]; then
+            echo "[ERROR] desired_versions generator did not produce an output file" >&2
+            exit 1
+          fi
+          cp -f "$latest_generated" desired_versions.sh
+
+      - name: Fallback missing component artifacts from releases (non-main)
+        if: github.ref != 'refs/heads/main'
+        env:
+          GITHUB_TOKEN: ${{ steps.generate-rekku-token.outputs.token }}
+          GITHUB_REPOSITORY: ${{ github.repository }}
+          MATCH_LABEL: cooker
+          FALLBACK_COMPONENTS_FILE: fallback_components.txt
+          MISSING_COMPONENTS_FILE: missing_components.txt
+        run: |
+          bash automation-tools/fallback_release_artifacts.sh
+
+      - name: Fail on missing artifacts (main only)
+        if: github.ref == 'refs/heads/main'
+        run: |
+          set -e
+          MISSING_ARTIFACTS=()
+          for folder in $(find . -maxdepth 2 -mindepth 2 -type f \( -name 'component_recipe.json' -o -name 'component_manifest.json' \) -printf '%h\n' | sed 's|^\./||' | sort -u); do
+            if [ ! -d "$folder/artifacts" ] || ! find "$folder/artifacts" -maxdepth 1 -type f \( -name "*.tar.gz" -o -name "*.zip" -o -name "*.gz" -o -name "*.tar" -o -name "*.7z" -o -name "*.appimage" \) | grep -q .; then
+              MISSING_ARTIFACTS+=("$folder")
+            fi
+          done
+          if [ ${#MISSING_ARTIFACTS[@]} -ne 0 ]; then
+            echo "[ERROR] Missing artifacts on main; failing build. Missing:" >&2
+            printf '%s\n' "${MISSING_ARTIFACTS[@]}" >&2
+            exit 1
+          fi
+
       - name: Generate components_version_list.md
+        env:
+          FALLBACK_COMPONENTS_FILE: fallback_components.txt
         run: |
           # Loop through each <component_name> folder
           for component_dir in */; do
@@ -240,6 +293,11 @@ jobs:
               continue
             fi
 
+            # Only process real components
+            if [[ ! -f "${component_dir}component_recipe.json" && ! -f "${component_dir}component_manifest.json" ]]; then
+              continue
+            fi
+
             # Path to artifacts directory
             artifacts_dir="${component_dir}artifacts"
 
@@ -280,15 +338,6 @@ jobs:
 
           # Show the resulting components_version_list.md file
           cat components_version_list.md
-      - name: Generate a token for Rekku
-        id: generate-rekku-token
-        uses: actions/create-github-app-token@v1
-        with:
-          app-id: ${{ vars.REKKU_APP_ID }}
-          private-key: ${{ secrets.REKKU_PRIVATE_KEY }}
-          repositories: "components"
-          owner: "RetroDECK"
-
       - name: Get Branch Name
         run: |
           if [[ "$GITHUB_EVENT_NAME" == "pull_request" || "$GITHUB_EVENT_NAME" == "pull_request_target" ]]; then
@@ -348,6 +397,16 @@ jobs:
           echo "This is a RetroDECK Components Artifacts release from [this commit](https://github.com/${{ github.repository }}/commit/${{ github.sha }}), from branch [${{ env.BRANCH_NAME }}](https://github.com/RetroDECK/RetroDECK/tree/feat/${{ env.BRANCH_NAME }})." >> "$RELEASE_BODY_FILE"
           echo "" >> "$RELEASE_BODY_FILE"
 
+          # Fallback warnings (if any)
+          if [ -f "fallback_components.txt" ] && [ -s "fallback_components.txt" ]; then
+            echo "[WARNING] Fallback artifacts were used for the following components:" >> "$RELEASE_BODY_FILE"
+            while IFS='|' read -r comp tag; do
+              [ -z "$comp" ] && continue
+              echo "- $comp (from release $tag)" >> "$RELEASE_BODY_FILE"
+            done < fallback_components.txt
+            echo "" >> "$RELEASE_BODY_FILE"
+          fi
+
           # Append the contents of components_version_list.md to the release body
           cat components_version_list.md >> "$RELEASE_BODY_FILE"
           echo "" >> "$RELEASE_BODY_FILE"
@@ -356,7 +415,7 @@ jobs:
           MISSING_ARTIFACTS=()
 
           # Iterate through folders in the repo root
-          for folder in $(find . -maxdepth 1 -mindepth 1 -type d -not -name '.*' -not -name 'automation-tools' -not -name 'downloaded-artifacts' -exec basename {} \;); do
+          for folder in $(find . -maxdepth 2 -mindepth 2 -type f \( -name 'component_recipe.json' -o -name 'component_manifest.json' \) -printf '%h\n' | sed 's|^\./||' | sort -u); do
             if [ ! -d "$folder/artifacts" ] || ! find "$folder/artifacts" -maxdepth 1 -type f \( -name "*.tar.gz" -o -name "*.zip" -o -name "*.gz" -o -name "*.tar" -o -name "*.7z" -o -name "*.appimage" \) | grep -q .; then
               MISSING_ARTIFACTS+=("$folder")
             fi
@@ -420,7 +479,7 @@ jobs:
           tag: "${{ env.TAG }}"
           name: "RetroDECK Components ${{ env.TAG }}"
           body: ${{ steps.generate-body.outputs.RELEASE_BODY }}
-          artifacts: "*/artifacts/*,!*/artifacts/component_version,components_version_list.md"
+          artifacts: "*/artifacts/*,!*/artifacts/component_version,components_version_list.md,desired_versions.sh"
           allowUpdates: true
           omitBodyDuringUpdate: true
           makeLatest: ${{ env.MAKE_LATEST }}
@@ -456,6 +515,16 @@ jobs:
           echo "## RetroDECK Components Artifacts" > pr_body.md
           echo "" >> pr_body.md
           echo "This pull request updates the RetroDECK components artifacts to version ${{ env.TAG }}." >> pr_body.md
+          echo "" >> pr_body.md
+
+          if [ -f "fallback_components.txt" ] && [ -s "fallback_components.txt" ]; then
+            echo "### WARNING: Fallback artifacts used" >> pr_body.md
+            while IFS='|' read -r comp tag; do
+              [ -z "$comp" ] && continue
+              echo "- $comp (from release $tag)" >> pr_body.md
+            done < fallback_components.txt
+            echo "" >> pr_body.md
+          fi
 
           echo "## Changes:" >> pr_body.md
           echo "$(cat commits_list.txt)" >> pr_body.md
diff --git a/automation-tools/fallback_release_artifacts.sh b/automation-tools/fallback_release_artifacts.sh
@@ -0,0 +1,166 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+# Fallback logic:
+# - For each component missing artifacts, try to download its latest available artifact from GitHub Releases.
+# - Search releases from newest to oldest and stop at the first match.
+# - Intended to be used ONLY for non-main branches (workflow should gate this).
+
+log() {
+  local level="$1"; shift
+  echo "[$level] $*" >&2
+}
+
+require_cmd() {
+  command -v "$1" >/dev/null 2>&1 || {
+    log ERROR "Missing required command: $1"
+    exit 1
+  }
+}
+
+require_cmd curl
+require_cmd jq
+
+REPO_ROOT="${REPO_ROOT:-$(git rev-parse --show-toplevel 2>/dev/null || pwd)}"
+GITHUB_REPOSITORY="${GITHUB_REPOSITORY:?GITHUB_REPOSITORY is required (e.g. RetroDECK/components)}"
+
+# Prefer an explicit token if provided; else unauthenticated requests.
+AUTH_HEADER=()
+if [[ -n "${GITHUB_TOKEN:-}" ]]; then
+  AUTH_HEADER=(-H "Authorization: token ${GITHUB_TOKEN}")
+fi
+
+# Label used to select releases (default: cooker). Keep aligned with workflow tagging.
+MATCH_LABEL="${MATCH_LABEL:-cooker}"
+
+FALLBACK_OUT_FILE="${FALLBACK_COMPONENTS_FILE:-fallback_components.txt}"
+MISSING_OUT_FILE="${MISSING_COMPONENTS_FILE:-missing_components.txt}"
+
+cd "$REPO_ROOT"
+
+detect_missing_components() {
+  local missing=()
+  while IFS= read -r folder; do
+    [[ -z "$folder" ]] && continue
+    if [[ ! -d "$folder" ]]; then
+      continue
+    fi
+
+    # Only treat directories as components if they have a component recipe/manifest.
+    if [[ ! -f "$folder/component_recipe.json" && ! -f "$folder/component_manifest.json" ]]; then
+      continue
+    fi
+
+    # Must have at least one artifact file to be considered present
+    if [[ ! -d "$folder/artifacts" ]] || ! find "$folder/artifacts" -maxdepth 1 -type f \( -name "*.tar.gz" -o -name "*.zip" -o -name "*.gz" -o -name "*.tar" -o -name "*.7z" -o -name "*.appimage" \) | grep -q .; then
+      missing+=("$folder")
+    fi
+  done < <(find . -maxdepth 1 -mindepth 1 -type d -not -name '.*' -exec basename {} \;)
+
+  printf '%s\n' "${missing[@]:-}"
+}
+
+fetch_releases_page() {
+  local page="$1"
+  local url="https://api.github.com/repos/${GITHUB_REPOSITORY}/releases?per_page=100&page=${page}"
+  curl -fsSL "${AUTH_HEADER[@]}" "$url"
+}
+
+find_asset_in_releases() {
+  local releases_json="$1"
+  local component="$2"
+  local asset_name="$3"
+
+  # Return a TSV line: <tag_name>\t<download_url> for the FIRST match
+  jq -r --arg label "$MATCH_LABEL" --arg name "$asset_name" '
+    .[]
+    | select(.tag_name | test($label))
+    | . as $rel
+    | ($rel.assets // [])[]?
+    | select(.name == $name)
+    | [$rel.tag_name, .browser_download_url]
+    | @tsv
+  ' <<<"$releases_json" | head -n 1
+}
+
+download_asset() {
+  local url="$1"
+  local out="$2"
+  mkdir -p "$(dirname "$out")"
+  curl -fL "${AUTH_HEADER[@]}" -o "$out" "$url"
+}
+
+main() {
+  : >"$FALLBACK_OUT_FILE"
+  : >"$MISSING_OUT_FILE"
+
+  mapfile -t missing_components < <(detect_missing_components)
+  if [[ ${#missing_components[@]} -eq 0 ]]; then
+    log INFO "No missing components detected."
+    return 0
+  fi
+
+  log WARN "Missing components detected: ${missing_components[*]}"
+  printf '%s\n' "${missing_components[@]}" >"$MISSING_OUT_FILE"
+
+  for component in "${missing_components[@]}"; do
+    local_tar_name="${component}.tar.gz"
+    local_sha_name="${component}.tar.gz.sha"
+
+    found_tag=""
+    url_tar=""
+    url_sha=""
+
+    for page in 1 2 3 4 5; do
+      releases_json=""
+      if ! releases_json=$(fetch_releases_page "$page" 2>/dev/null); then
+        log WARN "Failed to fetch releases page ${page}; continuing..."
+        continue
+      fi
+
+      # Stop if API returned an empty array
+      if [[ "$(jq -r 'length' <<<"$releases_json")" == "0" ]]; then
+        break
+      fi
+
+      tar_match=$(find_asset_in_releases "$releases_json" "$component" "$local_tar_name" || true)
+      sha_match=$(find_asset_in_releases "$releases_json" "$component" "$local_sha_name" || true)
+
+      if [[ -n "$tar_match" ]]; then
+        found_tag=$(cut -f1 <<<"$tar_match")
+        url_tar=$(cut -f2 <<<"$tar_match")
+      fi
+      if [[ -n "$sha_match" ]]; then
+        # Prefer the tag from tar_match if present; else from sha_match
+        [[ -z "$found_tag" ]] && found_tag=$(cut -f1 <<<"$sha_match")
+        url_sha=$(cut -f2 <<<"$sha_match")
+      fi
+
+      if [[ -n "$url_tar" ]]; then
+        break
+      fi
+    done
+
+    if [[ -z "$url_tar" ]]; then
+      log ERROR "Fallback not found for component '$component' (searched releases matching '${MATCH_LABEL}')."
+      continue
+    fi
+
+    log WARN "Using fallback for '$component' from release '$found_tag'"
+    download_asset "$url_tar" "$REPO_ROOT/$component/artifacts/$local_tar_name"
+    if [[ -n "$url_sha" ]]; then
+      download_asset "$url_sha" "$REPO_ROOT/$component/artifacts/$local_sha_name"
+    fi
+
+    echo "${component}|${found_tag}" >>"$FALLBACK_OUT_FILE"
+  done
+
+  if [[ -s "$FALLBACK_OUT_FILE" ]]; then
+    log INFO "Fallback used for: $(cut -d'|' -f1 "$FALLBACK_OUT_FILE" | tr '\n' ' ' | sed 's/[[:space:]]*$//')"
+  else
+    log INFO "No fallback artifacts were recovered."
+  fi
+}
+
+main "$@"
diff --git a/automation-tools/write_components_version.sh b/automation-tools/write_components_version.sh
