SONARXML-322 Use shared update rule metadata worflow (#426)

Author: tomasz-tylenda-sonarsource

.github/workflows/UpdateRuleMetadata.yml

@@ -2,72 +2,30 @@ name: Update Rule Metadata
 
 on: workflow_dispatch
 
-env:
-  PR_BRANCH_NAME: "gh-action/update-rule-metadata.${{ github.run_id }}"
-
 jobs:
-  UpdateRuleMetadata_job:
-    name: Update Rule Metadata
+  update-rule-metadata:
     runs-on: github-ubuntu-latest-s
     permissions:
-      pull-requests: write
-      contents: write
       id-token: write
-
+      contents: write
+      pull-requests: write
     steps:
-
-      - name: Checkout Sources
-        uses: actions/checkout@v4
-
-      - name: Setup JFrog
-        uses: SonarSource/jfrog-setup-wrapper@v3
+      - name: Update Rule Metadata
+        id: update-rule-metadata
+        uses: SonarSource/release-github-actions/update-rule-metadata@v1
         with:
-          artifactoryRoleSuffix: private-reader
-
-      - name: Setup Rule API
-        run: |
-          jfrog rt curl -sLf "sonarsource-private-releases/com/sonarsource/rule-api/rule-api/%5BRELEASE%5D/rule-api-%5BRELEASE%5D.jar" -o rule-api.jar
-          echo "Latest com.sonarsource.rule-api:rule-api release:"
-          jar xf rule-api.jar META-INF/MANIFEST.MF
-          grep 'Implementation-Version' META-INF/MANIFEST.MF
-        working-directory: /tmp
-
-      - name: Setup Java
-        uses: actions/setup-java@v4
-        with:
-          distribution: 'temurin'
-          java-version: '21'
-
-      - name: Getting Vault Secrets
-        id: secrets
-        uses: SonarSource/vault-action-wrapper@545e7cfbb5528e7009a1edcc83e073898d292627 # 3.2.0
-        with:
-          secrets: |
-            development/github/token/{REPO_OWNER_NAME_DASH}-rspec token | GITHUB_TOKEN_RSPEC;
-
-      - name: Update Files
-        env:
-          GITHUB_TOKEN: ${{ fromJSON(steps.secrets.outputs.vault).GITHUB_TOKEN_RSPEC }}
-        run: |
-          java -jar "/tmp/rule-api.jar" update
-          java -jar "/tmp/rule-api.jar" generate -rule XPathCheck
-          cp sonar-xml-plugin/src/main/resources/org/sonar/l10n/xml/rules/xml/S140.html sonar-xml-plugin/src/main/resources/org/sonar/l10n/xml/rules/xml/XPathCheck.html
-          cp sonar-xml-plugin/src/main/resources/org/sonar/l10n/xml/rules/xml/S140.json sonar-xml-plugin/src/main/resources/org/sonar/l10n/xml/rules/xml/XPathCheck.json
-
-      - name: Create PR
-        id: create-pr
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          git config user.name "${GITHUB_ACTOR}"
-          git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
-          git checkout -b "${{ env.PR_BRANCH_NAME }}"
-          git commit -m 'Update rule metadata' -a
-          git push --set-upstream origin "${{ env.PR_BRANCH_NAME }}"
-          URL=$(gh pr create -B master --title 'Update rule metadata' --body '')
-          echo "url=${URL}" >> $GITHUB_OUTPUT
-
-      - name: Summary
+          labels: ''
+          # The default suffix is `rspec-read`, but JVM Squad uses just `rspec`.
+          rspec-token-suffix: 'rspec'
+          post-update: |
+            java -jar rule-api.jar generate -rule XPathCheck
+            cp sonar-xml-plugin/src/main/resources/org/sonar/l10n/xml/rules/xml/S140.html sonar-xml-plugin/src/main/resources/org/sonar/l10n/xml/rules/xml/XPathCheck.html
+            cp sonar-xml-plugin/src/main/resources/org/sonar/l10n/xml/rules/xml/S140.json sonar-xml-plugin/src/main/resources/org/sonar/l10n/xml/rules/xml/XPathCheck.json
+
+      - name: Check Rule Metadata Changes
         run: |
-          echo "Generated ${{steps.create-pr.outputs.url}}." >> $GITHUB_STEP_SUMMARY
-          echo "Tip: close and reopen the PR to trigger CI. " >> $GITHUB_STEP_SUMMARY
+          if [ "${{ steps.update-rule-metadata.outputs.has-changes }}" == "true" ]; then
+            echo "::notice title=Rule Metadata Changes::Changes detected and PR created: ${{ steps.update-rule-metadata.outputs.pull-request-url }}"
+          else
+            echo "::notice title=Rule Metadata Status::No changes to the rules metadata were detected"
+          fi