Add to README how to checkout PR in issue_comment event

[ADTC]

Closes #331

[zyv]

I think the alternative with gh cli is worth mentioning, especially if afterwards one wants to do something with the branch.

[ADTC]

@zyv is that the same as the latest comment in the issue? If not, please share your version here.

[zyv]

@ADTC nope, I meant this option:

- uses: actions/checkout@v3

- run: hub pr checkout ${{ github.event.issue.number }}
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Your option is nice, but it's only useful if you want to check out the code e.g. for static checks or something. The downside though is that if you check out the code your way, you can't use the resulting checkout to push the changes back to the branch with git push afterwards.

That's why I suggest to mention both alternatives if not the more generic one, and explain the caveat of your "nicer" solution, to spare folks trying to push their changes back banging the head against the wall for too long.

[ADTC]

@zyv what's the functional difference between your version and the one in this comment? Looks like they both do the same action, with yours being simpler code. Is that right?

Also, what's the difference between gh pr and hub pr?

[zyv]

@zyv what's the functional difference between your version and the one in this comment? Looks like they both do the same action, with yours being simpler code. Is that right?

Correct.

Also, what's the difference between gh pr and hub pr?

gh is better:

https://github.com/cli/cli/blob/trunk/docs/gh-vs-hub.md

I guess you can just replace hub with gh in my code, but I haven't tested that.

[ADTC]

I guess you can just replace hub with gh in my code, but I haven't tested that.

It will need to be tested. From what I gather, gh is not guaranteed to be backwards compatible with hub.

Also, are both hub and gh available by default in GitHub actions, or do you need to install them?

[zyv]

Also, are both hub and gh available by default in GitHub actions, or do you need to install them?

Yes, see:

https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#preinstalled-software

Search for "GitHub CLI".