Update GitHub Action CI for Forks #220
Conversation
| @@ -10,6 +10,9 @@ jobs: | |||
| steps: | |||
| - name: Check out repository | |||
| uses: actions/checkout@v3 | |||
| with: | |||
| ref: ${{ github.event.pull_request.head.ref }} | |||
| repository: ${{ github.event.pull_request.head.repo.full_name }} | |||
There was a problem hiding this comment.
Hey Jax, thanks for doing this! Can you tell me how this allows CI to run as expected on forks? Just high level explanation would be fine!
There was a problem hiding this comment.
Ref Line
github.event references where we want to run CI (context docs) in our case we want to run CI on the pull_request. For PRs we want to run CI on the pull request's head branch name head.ref vs the base branch name (PR workflow events docs). So this line github.event.pull_request.head.ref is essentially saying: run CI on the branch the PR was opened from.
Repository Line
github.event.pull_request.head is the same as above so it's saying for the repository use the PRs head vs main. Then repo.full_name pulls the full path of the repo the fork is on vs attempting to pull the branch name from our path where it wouldn't exist (reference docs here).
Reason for changes
CI should run as expected on forks!
Summary of changes
Checklist
[ ] Added a changelog entryAuthors