Enhance GitCompare workflow: add error handling, improve output logging, and ensure permissions for pull requests

Author: ShantKhatri

.github/workflows/gitcompare.yml

@@ -11,6 +11,7 @@ jobs:
     permissions:
       contents: read
       issues: write
+      pull-requests: write
     outputs:
       good_build: ${{ steps.parse.outputs.good_build }}
       bad_build: ${{ steps.parse.outputs.bad_build }}
@@ -33,6 +34,9 @@ jobs:
           GOOD_BUILD=$(echo "$GOOD_BUILD" | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
           BAD_BUILD=$(echo "$BAD_BUILD" | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
           
+          echo "Good build: '$GOOD_BUILD'"
+          echo "Bad build: '$BAD_BUILD'"
+          
           # Validate builds
           if [ -z "$GOOD_BUILD" ] || [ -z "$BAD_BUILD" ]; then
             echo "Error: Invalid format. Please provide both good and bad builds separated by ---"
@@ -58,6 +62,7 @@ jobs:
     permissions:
       contents: read
       issues: write
+      pull-requests: write
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -69,19 +74,37 @@ jobs:
           BAD_BUILD: ${{ needs.parse-comment.outputs.bad_build }}
         run: |
           cd CommitHunter
+          echo "Running commit_hunter.sh with:"
+          echo "Good build: $GOOD_BUILD"
+          echo "Bad build: $BAD_BUILD"
           bash commit_hunter.sh "$GOOD_BUILD" "$BAD_BUILD" > output.txt
+          echo "CommitHunter output:"
           cat output.txt
 
       - name: Parse URLs from output
         id: parse_urls
         run: |
-          url_openj9=$(grep "OpenJ9:" output.txt | awk '{print $2}')
-          url_omr=$(grep "OMR:" output.txt | awk '{print $2}')
-          url_jcl=$(grep "JCL:" output.txt | awk '{print $2}')
-
-          echo "url_openj9=$url_openj9" >> $GITHUB_OUTPUT
-          echo "url_omr=$url_omr" >> $GITHUB_OUTPUT
-          echo "url_jcl=$url_jcl" >> $GITHUB_OUTPUT
+          if [ -f "./CommitHunter/output.txt" ]; then
+            echo "Found output file, parsing URLs..."
+            cat ./CommitHunter/output.txt
+            
+            url_openj9=$(grep "OpenJ9:" ./CommitHunter/output.txt | awk '{print $2}')
+            url_omr=$(grep "OMR:" ./CommitHunter/output.txt | awk '{print $2}')
+            url_jcl=$(grep "JCL:" ./CommitHunter/output.txt | awk '{print $2}')
+            
+            echo "Parsed URLs:"
+            echo "OpenJ9: $url_openj9"
+            echo "OMR: $url_omr"
+            echo "JCL: $url_jcl"
+            
+            echo "url_openj9=$url_openj9" >> $GITHUB_OUTPUT
+            echo "url_omr=$url_omr" >> $GITHUB_OUTPUT
+            echo "url_jcl=$url_jcl" >> $GITHUB_OUTPUT
+          else
+            echo "Error: output.txt not found in CommitHunter directory"
+            ls -la ./CommitHunter/
+            exit 1
+          fi
 
       - name: Prepare comment
         run: |
@@ -97,29 +120,39 @@ jobs:
           echo "${{ steps.parse_urls.outputs.url_jcl }}" >> comment.md
           echo "" >> comment.md
           echo "> 💡 **Note:** These links show the differences between the specified builds."
+          
+          echo "Prepared comment:"
+          cat comment.md
 
-      - name: Set issue number env
-        run: echo "ISSUE_NUMBER=${{ github.event.issue.number }}" >> $GITHUB_ENV
-  
-      - name: Comment on PR (Python)
+      - name: Comment on PR
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           GITHUB_REPOSITORY: ${{ github.repository }}
+          ISSUE_NUMBER: ${{ github.event.issue.number }}
         run: |
           pip install PyGithub
-          python <<EOF
+          python3 <<EOF
           import os
+          import sys
           from github import Github
-
-          with open("comment.md", "r", encoding="utf-8") as f:
-              comment_body = f.read()
-
-          token = os.environ["GITHUB_TOKEN"]
-          repo_name = os.environ["GITHUB_REPOSITORY"]
-          issue_number = int(os.environ["ISSUE_NUMBER"])
-
-          g = Github(token)
-          repo = g.get_repo(repo_name)
-          issue = repo.get_issue(number=issue_number)
-          issue.create_comment(comment_body)
+          
+          try:
+              with open("comment.md", "r", encoding="utf-8") as f:
+                  comment_body = f.read()
+              
+              token = os.environ["GITHUB_TOKEN"]
+              repo_name = os.environ["GITHUB_REPOSITORY"]
+              issue_number = int(os.environ["ISSUE_NUMBER"])
+              
+              g = Github(token)
+              repo = g.get_repo(repo_name)
+              issue = repo.get_issue(number=issue_number)
+              
+              comment = issue.create_comment(comment_body)
+              print(f"✅ Comment created successfully: {comment.html_url}")
+              
+          except Exception as e:
+              print(f"❌ Error creating comment: {e}")
+              print(f"Error type: {type(e).__name__}")
+              sys.exit(1)
           EOF