checkout/README.md

106 lines
3.5 KiB
Markdown
Raw Normal View History

<p align="center">
<a href="https://github.com/actions/checkout"><img alt="GitHub Actions status" src="https://github.com/actions/checkout/workflows/test-local/badge.svg"></a>
</p>
2019-12-03 17:35:57 +01:00
# Checkout V2 beta
This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it.
By default, the repository that triggered the workflow is checked-out, for the ref/SHA that triggered the event.
Refer [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn which commit `$GITHUB_SHA` points to for different events.
2019-12-06 04:10:31 +01:00
# What's new
2019-12-03 17:26:12 +01:00
- Improved fetch performance
- The default behavior now fetches only the commit being checked-out
2019-12-03 17:26:12 +01:00
- Script authenticated git commands
2019-12-12 19:49:26 +01:00
- Persists the input `token` in the local git config
2019-12-03 17:26:12 +01:00
- Enables your scripts to run authenticated git commands
- Post-job cleanup removes the token
2019-12-12 19:49:26 +01:00
- Opt out by setting the input `persist-credentials: false`
2019-12-03 17:26:12 +01:00
- Creates a local branch
- No longer detached HEAD when checking out a branch
- A local branch is created with the corresponding upstream branch set
- Improved layout
2019-12-12 19:49:26 +01:00
- The input `path` is always relative to $GITHUB_WORKSPACE
- Aligns better with container actions, where $GITHUB_WORKSPACE gets mapped in
- Fallback to REST API download
- When Git 2.18 or higher is not in the PATH, the REST API will be used to download the files
2019-12-03 17:26:12 +01:00
- Removed input `submodules`
Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous versions.
# Usage
<!-- start usage -->
```yaml
2019-12-03 17:26:12 +01:00
- uses: actions/checkout@v2-beta
with:
2019-12-03 22:47:19 +01:00
# Repository name with owner. For example, actions/checkout
# Default: ${{ github.repository }}
repository: ''
2019-12-12 19:49:26 +01:00
# The branch, tag or SHA to checkout. When checking out the repository that
2019-12-05 05:43:03 +01:00
# triggered a workflow, this defaults to the reference or SHA for that event.
# Otherwise, defaults to `master`.
ref: ''
2019-12-12 19:49:26 +01:00
# Auth token used to fetch the repository. The token is stored in the local git
# config, which enables your scripts to run authenticated git commands. The
# post-job step removes the token from the git config.
# Default: ${{ github.token }}
token: ''
2019-12-12 19:49:26 +01:00
# Whether to persist the token in the git config
# Default: true
persist-credentials: ''
# Relative path under $GITHUB_WORKSPACE to place the repository
path: ''
# Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching
# Default: true
clean: ''
# Number of commits to fetch. 0 indicates all history.
# Default: 1
fetch-depth: ''
# Whether to download Git-LFS files
# Default: false
lfs: ''
```
<!-- end usage -->
## Checkout a different branch
```yaml
- uses: actions/checkout@v2-beta
with:
ref: some-branch
```
## Checkout a different, private repository
```yaml
- uses: actions/checkout@v2-beta
with:
repository: myAccount/myRepository
ref: refs/heads/master
token: ${{ secrets.GitHub_PAT }} # `GitHub_PAT` is a secret that contains your PAT
```
> - `${{ 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.pull_request.head.sha }}
```
# License
The scripts and documentation in this project are released under the [MIT License](LICENSE)