Merge remote-tracking branch 'upstream/test-redirect-gh-action' into regex

Author: norareidy

.github/workflows/add-redirects.yml

@@ -8,13 +8,21 @@ jobs:
     name: Verifying Redirects
     runs-on: ubuntu-latest
     env:
-      REDIRECTS_FILE: "config/redirects"
+      REDIRECTS_FILE: "pr/config/redirects"
     permissions:
       pull-requests: write
     steps:
       - name: Check Out Base Branch
         uses: actions/checkout@v4
-
+      
+      - name: Checkout PR Head Branch  
+        uses: actions/checkout@v4  
+        with:  
+          token: ${{ secrets.GITHUB_TOKEN }}  
+          ref: ${{ github.event.pull_request.head.ref }}  
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          path: pr
+      
       - name: Get Changed Files
         id: changed-files
         uses: tj-actions/changed-files@c65cd883420fd2eb864698a825fc4162dd94482c
@@ -27,7 +35,7 @@ jobs:
         env:
           RENAMED_FILES: ${{ steps.changed-files.outputs.all_old_new_renamed_files }}
         run: |
-          renamed_redirects=()
+          renamed_redirects=""
           for file in $RENAMED_FILES; do
 
             # only run for .txt files
@@ -44,22 +52,26 @@ jobs:
             new="${new%.txt}"
             
             # single quotes = ${var} rendered literally; double quotes = $var interpreted
-            renamed_redirect='${prefix}/${version}'"$old"'/ -> ${base}/${version}'"$new"'/'
+            redirect='${prefix}/${version}'"$old"'/ -> ${base}/${version}'"$new"'/'
 
-            # if redirect not already in file, add to array to add to PR description
-            if ! grep -q "$renamed_redirect" $REDIRECTS_FILE; then
-              renamed_redirects+=("$renamed_redirect")
+            # if redirect not already in file, add to string to add to PR description
+            if ! grep -q "$redirect" $REDIRECTS_FILE; then
+              renamed_redirects+="$redirect,"
             fi
           done
-          echo "redirects=${renamed_redirects}" >> "$GITHUB_OUTPUT"
+
+          # cut trailing comma
+          renamed_redirects="${renamed_redirects%,}"
+
+          echo "redirects=${renamed_redirects}" >> "$GITHUB_OUTPUT"  
 
       - name: Find Missing Redirects for Deleted Files
         id: deleted-files
         if: steps.changed-files.outputs.deleted_files_count > 0
         env:
           DELETED_FILES: ${{ steps.changed-files.outputs.deleted_files }}
         run: |
-          deleted_redirects=()
+          deleted_redirects=""
           for file in $DELETED_FILES; do
 
             # only run for .txt files
@@ -73,15 +85,18 @@ jobs:
             old="${old%.txt}"
             
             # single quotes = ${var} rendered literally; double quotes = $var interpreted
-            deleted_redirect='${prefix}/${version}'"$old"'/ -> ${base}/${version}/'
+            redirect='${prefix}/${version}'"$old"'/ -> ${base}/${version}/'
                        
-            # if redirect not already in file, add to array to add to PR description
-            if ! grep -q "$deleted_redirect" $REDIRECTS_FILE; then  
-              deleted_redirects+=("$deleted_redirect")
+            # if redirect not already in file, add to string to add to PR description
+            if ! grep -q "$redirect" $REDIRECTS_FILE; then 
+              deleted_redirects+="$redirect,"
             fi
-
           done
-          echo "redirects=${deleted_redirects}" >> "$GITHUB_OUTPUT"
+          
+          # cut trailing comma
+          deleted_redirects="${deleted_redirects%,}"
+
+          echo "redirects=${deleted_redirects}" >> "$GITHUB_OUTPUT"  
 
       - name: Build Redirect HTML
         id: build-redirect-html
@@ -91,41 +106,38 @@ jobs:
         run: |
           # empty string that stays empty if there are no redirects to suggest
           redirect_html=""
-
-          for renamed_redirect in "${RENAMED_REDIRECTS[@]}"; do
-            redirect_html+="<li>[&lt;v&gt;-*]: $renamed_redirect</li>"
+          
+          combined_redirect_string="${RENAMED_REDIRECTS},${DELETED_REDIRECTS}"
+
+          for redirect in $combined_redirect_string; do
+            if [[ ! -z "$redirect" ]]; then
+              if [[ redirect_html="" ]]; then
+                redirect_html="*Suggested redirects for moved/deleted files (replace &lt;v&gt; with earliest backport target version):*"
+              fi
+              redirect_html+="<li>[&lt;v&gt;-*]: $redirect</li>"  
+            fi  
           done
-
-          for deleted_redirect in "${DELETED_REDIRECTS[@]}"; do
-            redirect_html+="<li>[&lt;v&gt;-*]: $deleted_redirect</li>"
-          done
-
+          
           echo "redirect_html=${redirect_html}" >> "$GITHUB_OUTPUT"
 
       - name: Update PR Description
-        if: steps.build-redirect-html.outputs.redirect_html
         uses: MongoCaleb/pr-description-action@4bdfe35b98f64532b419ad20b350a92546cd3aa1
-        env:
-          REDIRECT_HTML: ${{ steps.build-redirect-html.outputs.redirect_html }}
         with:
           regex: "- \\[ \\] Did you add redirects\\?.*"
           appendContentOnMatchOnly: false
           regexFlags: is
-          content: "- [ ] Did you add redirects?\n *Suggested redirects for moved/deleted files (replace &lt;v&gt; with earliest backport target version):*\n${{ steps.build-redirect-html.outputs.redirect_html }}\n"
+          content: "- [ ] Did you add redirects?\n ${{ steps.build-redirect-html.outputs.redirect_html }}"
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Check for duplicates in redirects file
         run: |
-          # Specify the file to check  
-          file="$REDIRECTS_FILE"
-
-          if [[ -f "$file" ]]; then  
-            duplicates=$(sort "$file" | uniq -d)  
+          if [[ -f "$REDIRECTS_FILE" ]]; then  
+            duplicates=$(sort "$REDIRECTS_FILE" | uniq -d)  
             if [[ -n "$duplicates" ]]; then  
-              echo "Duplicate lines found in $file:"  
+              echo "Duplicate lines found in $REDIRECTS_FILE:" 
               echo "$duplicates"  
               exit 1 # error
             fi
           else  
-            echo "File $file does not exist. Skipping duplicate check."  
+            echo "Redirects file doesn't exist. Skipping duplicate check."  
           fi