[CI] Refactor PR actions workflow (#3955)

Author: svrnm

.github/workflows/pr-actions.yml

@@ -11,87 +11,13 @@ env:
   USER_NAME: opentelemetrybot
 
 jobs:
-  fix-format:
-    name: /fix:format
+  pr-action:
+    name: Run PR action
     runs-on: ubuntu-latest
 
     if: |
       github.event.issue.pull_request &&
-      contains(github.event.comment.body, '/fix:format')
-    permissions:
-      contents: write
-      pull-requests: write
-
-    steps:
-      - name: Context info
-        run: |
-          echo $PR_NUM
-          echo $COMMENT
-
-      - uses: actions/checkout@v4
-
-      - name: Write start comment
-        run: |
-          gh pr comment $PR_NUM -b "You triggered fix:format action run at $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"
-        env:
-          GH_TOKEN: ${{ github.token }}
-
-      - run: gh pr checkout $PR_NUM -b "pr-action-${RANDOM}"
-        env:
-          GH_TOKEN: ${{ github.token }}
-
-      - name: Create NPM cache-hash input file
-        run: |
-          mkdir -p tmp
-          jq '{devDependencies, dependencies, engines, gitHubActionCacheKey}' package.json > tmp/package-ci.json
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version-file: .nvmrc
-          cache: npm
-          cache-dependency-path: tmp/package-ci.json
-
-      - run: |
-          npm run format
-          git status
-          git branch -v
-
-      - name: Commit and push changes, if any
-        run: |
-          git config --local user.email "$USER_EMAIL"
-          git config --local user.name "$USER_NAME"
-          if [[ $(git status --porcelain) ]]; then
-            git add -A
-            current_branch=$(git rev-parse --abbrev-ref HEAD)
-            echo current_branch=$current_branch
-            # gh pr checkout sets some git configs that we can use to make sure
-            # we push to the right repo & to the right branch
-            remote_repo=$(git config --get branch.${current_branch}.remote)
-            echo remote_repo=$remote_repo
-            remote_branch=$(git config --get branch.${current_branch}.merge)
-            echo remote_branch=$remote_branch
-            git commit -m 'Results from /fix:format'
-            git push ${remote_repo} HEAD:${remote_branch}
-          else
-            echo "No changes to commit"
-          fi
-        env:
-          GH_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}
-
-      - name: Report an error in the case of failure
-        if: ${{ failure() || cancelled() }}
-        run: |
-          gh pr comment $PR_NUM -b "fix:format run failed, please check $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID for details"
-        env:
-          GH_TOKEN: ${{ github.token }}
-
-  fix-refcache:
-    name: /fix:refcache
-    runs-on: ubuntu-latest
-
-    if: |
-      github.event.issue.pull_request &&
-      contains(github.event.comment.body, '/fix:refcache')
+      startsWith(github.event.comment.body, '/fix:')
     permissions:
       contents: write
       pull-requests: write
@@ -100,6 +26,19 @@ jobs:
       DEPTH: --depth 100 # submodule clone depth
 
     steps:
+      - name: Extract action name
+        id: extract_action_name
+        run: |
+          PR_ACTION=$(echo $COMMENT | grep -oP '/fix:\K\w+')
+          echo "Action is $PR_ACTION"
+          ACTION_NAMES="format|submodules|refcache|all"
+          if [[ ! "$PR_ACTION" =~ ^($ACTION_NAMES)$ ]]; then
+            echo "Invalid action name: $PR_ACTION"
+            echo "Action name should be one of: $ACTION_NAMES"
+            exit 1
+          fi
+          echo "PR_ACTION=$PR_ACTION" >> "$GITHUB_ENV"
+
       - name: Context info
         run: |
           echo $PR_NUM
@@ -109,12 +48,10 @@ jobs:
 
       - name: Write start comment
         run: |
-          gh pr comment $PR_NUM -b "You triggered fix:refcache action run at $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"
+          gh pr comment $PR_NUM -b "You triggered fix:${PR_ACTION} action run at $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"
         env:
           GH_TOKEN: ${{ github.token }}
 
-      # By providing a branch name the checkout will not break if a branch with the
-      # same name exists already upstream (e.g. patch-X)
       - run: gh pr checkout $PR_NUM -b "pr-action-${RANDOM}"
         env:
           GH_TOKEN: ${{ github.token }}
@@ -130,9 +67,25 @@ jobs:
           cache: npm
           cache-dependency-path: tmp/package-ci.json
 
-      - run: npm install --omit=optional
       - run: |
-          npm run check:links
+          case $PR_ACTION in
+            format)
+              npm run format
+              ;;
+            submodules)
+              npm run sync
+              ;;
+            refcache)
+              npm install --omit=optional
+              npm run check:links
+              ;;
+            all)
+              npm install --omit=optional
+              npm run sync
+              npm run format
+              npm run check:links
+              ;;
+          esac
           git status
           git branch -v
 
@@ -150,7 +103,7 @@ jobs:
             echo remote_repo=$remote_repo
             remote_branch=$(git config --get branch.${current_branch}.merge)
             echo remote_branch=$remote_branch
-            git commit -m 'Results from /fix:refcache'
+            git commit -m "Results from /fix:${PR_ACTION}"
             git push ${remote_repo} HEAD:${remote_branch}
           else
             echo "No changes to commit"
@@ -161,6 +114,6 @@ jobs:
       - name: Report an error in the case of failure
         if: ${{ failure() || cancelled() }}
         run: |
-          gh pr comment $PR_NUM -b "fix:recache run failed, please check $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID for details"
+          gh pr comment $PR_NUM -b "fix:${PR_ACTION} run failed, please check $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID for details"
         env:
           GH_TOKEN: ${{ github.token }}