document scenario: checkout the head commit of a PR (#90)

This commit is contained in:
eric sciple 2019-12-04 10:12:10 -05:00 committed by GitHub
parent 4817b449b0
commit 01a434328a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 2 deletions

View File

@ -66,7 +66,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
## Checkout a different branch ## Checkout a different branch
```yaml ```yaml
- uses: actions/checkout@preview - uses: actions/checkout@v2-beta
with: with:
ref: some-branch ref: some-branch
``` ```
@ -74,7 +74,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
## Checkout a different, private repository ## Checkout a different, private repository
```yaml ```yaml
- uses: actions/checkout@preview - uses: actions/checkout@v2-beta
with: with:
repository: myAccount/myRepository repository: myAccount/myRepository
ref: refs/heads/master ref: refs/heads/master
@ -82,6 +82,14 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
``` ```
> - `${{ github.token }}` is scoped to the current repository, so if you want to checkout another repository that is private you will need to provide your own [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). > - `${{ github.token }}` is scoped to the current repository, so if you want to checkout another repository that is private you will need to provide your own [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
## Checkout the HEAD commit of a PR, rather than the merge commit
```yaml
- uses: actions/checkout@v2-beta
with:
ref: ${{ github.event.after }}
```
# License # License
The scripts and documentation in this project are released under the [MIT License](LICENSE) The scripts and documentation in this project are released under the [MIT License](LICENSE)