Compare commits

..

3 Commits

Author SHA1 Message Date
eric sciple
5881116d18 Update README.md 2019-12-05 22:10:31 -05:00
Edward Thomson
7990b10a0c Update description (#65) 2019-12-04 23:43:03 -05:00
eric sciple
01a434328a document scenario: checkout the head commit of a PR (#90) 2019-12-04 10:12:10 -05:00
2 changed files with 11 additions and 8 deletions

View File

@@ -10,7 +10,8 @@ By default, the repository that triggered the workflow is checked-out, for the r
Refer [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn which commit `$GITHUB_SHA` points to for different events. Refer [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn which commit `$GITHUB_SHA` points to for different events.
Changes in V2: # What's new
- Improved fetch performance - Improved fetch performance
- The default behavior now fetches only the SHA being checked-out - The default behavior now fetches only the SHA being checked-out
- Script authenticated git commands - Script authenticated git commands
@@ -38,8 +39,9 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
# Default: ${{ github.repository }} # Default: ${{ github.repository }}
repository: '' repository: ''
# Ref to checkout (SHA, branch, tag). For the repository that triggered the # The branch, tag or SHA to checkout. When checking out the repository that
# workflow, defaults to the ref/SHA for the event. Otherwise defaults to master. # triggered a workflow, this defaults to the reference or SHA for that event.
# Otherwise, defaults to `master`.
ref: '' ref: ''
# Access token for clone repository # Access token for clone repository
@@ -87,7 +89,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
```yaml ```yaml
- uses: actions/checkout@v2-beta - uses: actions/checkout@v2-beta
with: with:
ref: refs/pull/${{ github.event.number }}/head ref: ${{ github.event.after }}
``` ```
# License # License

View File

@@ -1,13 +1,14 @@
name: 'Checkout' name: 'Checkout'
description: 'Checkout a Git repository' description: 'Checkout a Git repository at a particular version'
inputs: inputs:
repository: repository:
description: 'Repository name with owner. For example, actions/checkout' description: 'Repository name with owner. For example, actions/checkout'
default: ${{ github.repository }} default: ${{ github.repository }}
ref: ref:
description: > description: >
Ref to checkout (SHA, branch, tag). For the repository that triggered the The branch, tag or SHA to checkout. When checking out the repository
workflow, defaults to the ref/SHA for the event. Otherwise defaults to master. that triggered a workflow, this defaults to the reference or SHA for
that event. Otherwise, defaults to `master`.
token: token:
description: 'Access token for clone repository' description: 'Access token for clone repository'
default: ${{ github.token }} default: ${{ github.token }}