send-comment PR for commit sha \"HEAD\" not found

[DavidGOrtega]

If I repeat the same workflow where the PR was done by cml pr send-comment seems to not found the PR for the given commit sha

{"level":"error","message":"PR for commit sha \"HEAD\" not found","stack":"Error: PR for commit sha \"HEAD\" not found\n    at CML.commentCreate (/usr/local/lib/node_modules/@dvcorg/cml/src/cml.js:148:15)\n    at async Object.exports.handler (/usr/local/lib/node_modules/@dvcorg/cml/bin/cml/send-comment.js:13:15)"}

[judahrand]

I'm running into the same thing with Github.

cml send-comment --update works in a workflow triggered by a PR but cml send-comment --pr --update does not.

[hlkcrcck]

Any updates or workarounds for that issue? It is not possible to send comments to the PR right now on Github

[0x2b3bfa0]

Tests

Note
Trigger the following workflows by pushing to a pull request

---

Contents of .github/workflows/test.yml

on: pull_request
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - run: gh api /repos/$GITHUB_REPOSITORY/commits/$GITHUB_SHA/pulls

Output

[]

---

Contents of .github/workflows/test.yml

on: pull_request
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - run: git log

Output

commit a7b6e521edaa09bc70a07c7d82473d7666399250 (grafted, HEAD, pull/81/merge)
Author: User <user@domain>
Date:   Thu Jun 2 00:00:00 2022 +0000

    Merge ef08639131b44b2049a9a14c35819709596b85e4 into 8147abb01296e65906cdc28440fc0ccd3a067b69

• ef08639131b44b2049a9a14c35819709596b85e4 is the last commit in the pull request branch (i.e. the commit that triggered the workflow)
• 8147abb01296e65906cdc28440fc0ccd3a067b69 is the last commit in the base branch
• a7b6e521edaa09bc70a07c7d82473d7666399250 is a merge commit invented by GitHub 🙀

[0x2b3bfa0]

Workaround

Checkout pull request HEAD commit instead of merge commit | permanent link

- uses: actions/checkout@v3
  with:
    ref: ${{ github.event.pull_request.head.sha }}

References

• What does "Checkout pull request HEAD commit instead of merge commit" mean? actions/checkout#426
• Why a merge commit for pull requests? actions/checkout#504

[0x2b3bfa0]

🔔 @judahrand & @hlkcrcck

[judahrand]

🔔 @judahrand & @hlkcrcck

Thank you for looking into this. This seems to be the answer! Probably worth adding this to the documentation somewhere?

[casperdcl]

• does uses: actions/checkout@v3 with.ref: ${{ github.event.pull_request.head.sha }} work on: [push, pull_request, ...] or does it break other triggers?
• are there any negative side-effects? Basically what's the answer to Why a merge commit for pull requests? actions/checkout#504?

[0x2b3bfa0]

Basically what's the answer to actions/checkout#504?

After a cursory search, this is the most plausible answer I have found; nothing official, though:

• What does "Checkout pull request HEAD commit instead of merge commit" mean? actions/checkout#426 (comment)

[0x2b3bfa0]

Does uses: actions/checkout@v3 with.ref: ${{ github.event.pull_request.head.sha }} work on: [push, pull_request, ...] or does it break other triggers?

Off the top of my head, pull_request.head.sha would be nullish if there is no pull request for the triggering event. 🤔