From b33a78af440a35b57f894658c0b60ffa9b6b6762 Mon Sep 17 00:00:00 2001
From: Silvan Mosberger <silvan.mosberger@tweag.io>
Date: Wed, 10 Apr 2024 23:57:56 +0200
Subject: [PATCH] Simplify GitHub action update script

With the advice from https://github.com/dependabot/cli/issues/301#issuecomment-2048440081
---
 scripts/update-github-actions.sh | 82 ++++++++++++++++----------------
 1 file changed, 40 insertions(+), 42 deletions(-)

diff --git a/scripts/update-github-actions.sh b/scripts/update-github-actions.sh
index b8ec5e5..8123589 100755
--- a/scripts/update-github-actions.sh
+++ b/scripts/update-github-actions.sh
@@ -3,54 +3,52 @@
 # This script calls the dependabot CLI (https://github.com/dependabot/cli)
 # to determine updates to GitHub Action dependencies in the local repository.
 # It then also applies the updates and outputs the results to standard output.
+# Hopefully there's built-in support for this in the future, see
+# https://github.com/dependabot/cli/issues/301
 
 set -euo pipefail
 
 REPO_ROOT=$1
 
-echo -e "<details><summary>GitHub Action updates</summary>\n\n"
+echo "<details><summary>GitHub Action updates</summary>"
+# Needed because GitHub's rendering of the first body line breaks down otherwise
+echo ""
 
 # CI sets the GH_TOKEN env var, which `gh auth token` defaults to if set
 githubToken=$(gh auth token)
 
-# Each dependabot update call tries to update all dependencies,
-# but it outputs individual results for each dependency,
-# with the intention of creating a PR for each.
-#
-# We want to have all changes together though,
-# so we'd need to merge updates of the same files together,
-# which could cause merge conflicts, no good.
-#
-# Instead, we run dependabot repeatedly,
-# each time only taking the first dependency update and updating the files with it,
-# such that the next iteration takes into account the previous updates.
-# We do this until there's no more dependencies to be updated,
-# at which point --exit-status will make jq return with a non-zero exit code.
-#
-# This does mean that dependabot internally needs to perform O(n^2) updates,
-# but this isn't a problem in practice, since we run these updates regularly,
-# so n is low.
-while
-  # Unused argument would be the remote GitHub repo, which is not used if we pass --local
-  create_pull_request=$(LOCAL_GITHUB_ACCESS_TOKEN="$githubToken" \
-    dependabot update github_actions this-argument-is-unused --local "$REPO_ROOT" \
-    | jq --exit-status --compact-output --slurp 'map(select(.type == "create_pull_request")) | .[0].data')
-do
-  title=$(jq --exit-status --raw-output '."pr-title"' <<< "$create_pull_request")
-  echo "<details><summary>$title</summary>"
-
-  # Needed because GitHub's rendering of the first body line breaks down otherwise
-  echo ""
-
-  jq --exit-status --raw-output '."pr-body"' <<< "$create_pull_request"
-  echo '</details>'
-
-  jq --compact-output '."updated-dependency-files"[]' <<< "$create_pull_request" \
-    | while read -r fileUpdate; do
-      file=$(jq --exit-status --raw-output '.name' <<< "$fileUpdate")
-      # --join-output makes sure to not output a trailing newline
-      jq --exit-status --raw-output --join-output '.content' <<< "$fileUpdate" > "$REPO_ROOT/$file"
-    done
-done
-
-echo -e "</details>"
+tmp=$(mktemp -d)
+trap 'rm -rf "$tmp"' exit
+
+# Use dependency groups to update all dependencies together
+# Note that repo is not used because we pass `--local` on the CLI
+cat <<EOF > "$tmp/input.yml"
+job:
+  package-manager: "github_actions"
+  allowed-updates:
+    - update-type: all
+  source:
+    directory: "/"
+    provider: github
+    repo: not/used
+  dependency-groups:
+    - name: actions
+      rules:
+        patterns:
+          - "*"
+EOF
+
+create_pull_request=$(LOCAL_GITHUB_ACCESS_TOKEN="$githubToken" \
+  dependabot update --file "$tmp/input.yml" --local "$REPO_ROOT" \
+  | jq 'select(.type == "create_pull_request").data')
+
+jq --exit-status --raw-output '."pr-body"' <<< "$create_pull_request"
+
+echo '</details>'
+
+jq --compact-output '."updated-dependency-files"[]' <<< "$create_pull_request" \
+  | while read -r fileUpdate; do
+    file=$(jq --exit-status --raw-output '.name' <<< "$fileUpdate")
+    # --join-output makes sure to not output a trailing newline
+    jq --exit-status --raw-output --join-output '.content' <<< "$fileUpdate" > "$REPO_ROOT/$file"
+  done