benchmarks.yml: Fix PR branch checkout when triggered by comment (#1998)

This commit resolves an issue in our GitHub Actions workflow where the correct PR branch was not being checked out when the workflow was triggered by an 'issue_comment' event. Previously, the workflow was set up to handle the 'pull_request_target' event correctly, but it did not account for the different context provided by 'issue_comment'.

The fix involves adding conditional steps in the workflow to handle the 'issue_comment' event. When the workflow is triggered by an 'issue_comment', it now uses the GitHub API to extract the PR number from the comment context. This information is then used to retrieve the PR details, including the head branch and the repository name. With these details, the workflow can now correctly check out the PR branch associated with the issue comment. This ensures that our benchmarks and other PR-related checks run against the appropriate branch, regardless of the triggering event.

Author: EwoutH

.github/workflows/benchmarks.yml

@@ -50,12 +50,36 @@ jobs:
           path: benchmarks/timings_1.pickle
       - name: Checkout PR branch
         uses: actions/checkout@v4
+        if: github.event_name == 'pull_request_target'
         with:
           ref: ${{ github.event.pull_request.head.ref }}
           repository: ${{ github.event.pull_request.head.repo.full_name }}
           fetch-depth: 0
           persist-credentials: false
           clean: false
+      - name: Checkout PR branch from issue comment
+        if: github.event_name == 'issue_comment'
+        uses: actions/github-script@v5
+        with:
+          script: |
+            const issue_number = context.issue.number;
+            const repository = context.repo.repo;
+            const owner = context.repo.owner;
+            const pr = await github.rest.pulls.get({ owner, repo: repository, pull_number: issue_number });
+            const ref = pr.data.head.ref;
+            const repoFullName = pr.data.head.repo.full_name;
+            console.log(`::set-output name=ref::${ref}`);
+            console.log(`::set-output name=repo::${repoFullName}`);
+          result-encoding: string
+      - name: Actual Checkout for Issue Comment
+        if: github.event_name == 'issue_comment'
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ steps.checkout-pr-branch-from-issue-comment.outputs.repo }}
+          ref: ${{ steps.checkout-pr-branch-from-issue-comment.outputs.ref }}
+          fetch-depth: 0
+          persist-credentials: false
+          clean: false
       - name: Download benchmark results
         uses: actions/download-artifact@v4
         with: