From 1baedfe375a9083157722b823b2f8466c4b48a0d Mon Sep 17 00:00:00 2001
From: Joe Wang <106995533+JoeWang1127@users.noreply.github.com>
Date: Tue, 3 Dec 2024 17:27:05 +0000
Subject: [PATCH] chore: update action version through shell script (#3397)

In this PR:
- Update composite action version in `update_generation_config.sh` so
that the action version is updated in the same PR with image update.
- Do not update the action version through renovate.
---
 .../scripts/update_generation_config.sh       | 38 ++++++++++++++++---
 .../templates/java_library/renovate.json      | 17 ---------
 2 files changed, 32 insertions(+), 23 deletions(-)

diff --git a/hermetic_build/library_generation/owlbot/templates/java_library/.github/scripts/update_generation_config.sh b/hermetic_build/library_generation/owlbot/templates/java_library/.github/scripts/update_generation_config.sh
index 561a313040..209c29b7b6 100644
--- a/hermetic_build/library_generation/owlbot/templates/java_library/.github/scripts/update_generation_config.sh
+++ b/hermetic_build/library_generation/owlbot/templates/java_library/.github/scripts/update_generation_config.sh
@@ -28,11 +28,23 @@ function update_config() {
     sed -i -e "s/^${key_word}.*$/${key_word}: ${new_value}/" "${file}"
 }
 
+# Update an action to a new version in GitHub action.
+function update_action() {
+    local key_word=$1
+    local new_value=$2
+    local file=$3
+    echo "Update ${key_word} to ${new_value} in ${file}"
+    # use a different delimiter because the key_word contains "/".
+    sed -i -e "s|${key_word}@v.*$|${key_word}@v${new_value}|" "${file}"
+}
+
 # The parameters of this script is:
 # 1. base_branch, the base branch of the result pull request.
 # 2. repo, organization/repo-name, e.g., googleapis/google-cloud-java
 # 3. [optional] generation_config, the path to the generation configuration,
 # the default value is generation_config.yaml in the repository root.
+# 4. [optional] workflow, the library generation workflow file,
+# the default value is .github/workflows/hermetic_library_generation.yaml.
 while [[ $# -gt 0 ]]; do
 key="$1"
 case "${key}" in
@@ -48,6 +60,10 @@ case "${key}" in
     generation_config="$2"
     shift
     ;;
+  --workflow)
+    workflow="$2"
+    shift
+    ;;
   *)
     echo "Invalid option: [$1]"
     exit 1
@@ -71,12 +87,17 @@ if [ -z "${generation_config}" ]; then
   echo "Use default generation config: ${generation_config}"
 fi
 
+if [ -z "${workflow}" ]; then
+    workflow=".github/workflows/hermetic_library_generation.yaml"
+    echo "Use default library generation workflow file: ${workflow}"
+fi
+
 current_branch="generate-libraries-${base_branch}"
 title="chore: Update generation configuration at $(date)"
 
-# try to find a open pull request associated with the branch
+# Try to find a open pull request associated with the branch
 pr_num=$(gh pr list -s open -H "${current_branch}" -q . --json number | jq ".[] | .number")
-# create a branch if there's no open pull request associated with the
+# Create a branch if there's no open pull request associated with the
 # branch; otherwise checkout the pull request.
 if [ -z "${pr_num}" ]; then
   git checkout -b "${current_branch}"
@@ -85,7 +106,7 @@ else
 fi
 
 mkdir tmp-googleapis
-# use partial clone because only commit history is needed.
+# Use partial clone because only commit history is needed.
 git clone --filter=blob:none https://github.com/googleapis/googleapis.git tmp-googleapis
 pushd tmp-googleapis
 git pull
@@ -94,15 +115,20 @@ popd
 rm -rf tmp-googleapis
 update_config "googleapis_commitish" "${latest_commit}" "${generation_config}"
 
-# update gapic-generator-java version to the latest
+# Update gapic-generator-java version to the latest
 latest_version=$(get_latest_released_version "com.google.api" "gapic-generator-java")
 update_config "gapic_generator_version" "${latest_version}" "${generation_config}"
 
-# update libraries-bom version to the latest
+# Update composite action version to latest gapic-generator-java version
+update_action "googleapis/sdk-platform-java/.github/scripts" \
+  "${latest_version}" \
+  "${workflow}"
+
+# Update libraries-bom version to the latest
 latest_version=$(get_latest_released_version "com.google.cloud" "libraries-bom")
 update_config "libraries_bom_version" "${latest_version}" "${generation_config}"
 
-git add "${generation_config}"
+git add "${generation_config}" "${workflow}"
 changed_files=$(git diff --cached --name-only)
 if [[ "${changed_files}" == "" ]]; then
     echo "The latest generation config is not changed."
diff --git a/hermetic_build/library_generation/owlbot/templates/java_library/renovate.json b/hermetic_build/library_generation/owlbot/templates/java_library/renovate.json
index cb92a78173..57929084fd 100644
--- a/hermetic_build/library_generation/owlbot/templates/java_library/renovate.json
+++ b/hermetic_build/library_generation/owlbot/templates/java_library/renovate.json
@@ -44,16 +44,6 @@
       ],
       "depNameTemplate": "com.google.cloud:sdk-platform-java-config",
       "datasourceTemplate": "maven"
-    },
-    {
-      "fileMatch": [
-        "^.github/workflows/hermetic_library_generation.yaml$"
-      ],
-      "matchStrings": [
-        "uses: googleapis/sdk-platform-java/.github/scripts@v(?<currentValue>.+?)\\n"
-      ],
-      "depNameTemplate": "com.google.api:gapic-generator-java",
-      "datasourceTemplate": "maven"
     }
   ],
   "packageRules": [
@@ -114,13 +104,6 @@
         "^com.fasterxml.jackson.core"
       ],
       "groupName": "jackson dependencies"
-    },
-    {
-      "matchPackagePatterns": [
-        "^com.google.api:gapic-generator-java",
-        "^com.google.cloud:sdk-platform-java-config"
-      ],
-      "groupName": "SDK platform Java dependencies"
     }
   ],
   "semanticCommits": true,