actions/checkout
1
0
Fork 0
mirror of https://github.com/actions/checkout.git synced 2025-04-18 06:06:01 +02:00
Code Activity

Upgrade checkout to v1.1.0 to better support scripting git.

Browse source
This commit is contained in:
Tingluo Huang 2019-10-14 14:58:03 -04:00
parent f6ce2afa70
commit d265d21cbb
2 changed files with 25 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -13,7 +13,7 @@ Basic:
```yaml
steps:
- uses: actions/checkout@master
- uses: actions/checkout@v1.0.0
- uses: actions/setup-node@master
with:
node-version: 10.x
@ -21,15 +21,35 @@ steps:
- run: npm test
```
By default, the branch or tag ref that triggered the workflow will be checked out. If you wish to check out a different branch, specify that using `with.ref`:
By default, the branch or tag ref that triggered the workflow will be checked out, `${{ github.token }}` will be used for any Git server authentication. If you wish to check out a different branch, a different repository or use different token to checkout, specify that using `with.ref`, `with.repository` and `with.token`:
Checkout different branch from the workflow repository:
```yaml
- uses: actions/checkout@master
- uses: actions/checkout@v1.0.0
with:
ref: some-branch
```
For more details, see [Contexts and expression syntax for GitHub Actions](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions)
Checkout different private repository:
```yaml
- uses: actions/checkout@v1.0.0
with:
repository: myAccount/myRepository
ref: refs/heads/release
token: ${{ secrets.GitHub_PAT }} // `GitHub_PAT` is a secret contains your PAT.
```
Checkout private submodules:
```yaml
- uses: actions/checkout@v1.0.0
with:
submodules: recursive
token: ${{ secrets.GitHub_PAT }} // `GitHub_PAT` is a secret contains your PAT.
```
> - `with.token` will be used as `Basic` authentication header for https requests talk to https://github.com from `git(.exe)`, ensure those private submodules are configured via `https` not `ssh`.
> - `${{ github.token }}` only has permission to the workflow triggering repository. If the repository contains any submodules that comes from private repository, you will have to add your PAT as secret and use the secret in `with.token` to make `checkout` action work.
For more details, see [Contexts and expression syntax for GitHub Actions](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions) and [Creating and using secrets (encrypted variables)](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables)
# License

2
action.yml
View file

@ -20,4 +20,4 @@ inputs:
description: 'Optional path to check out source code'
runs:
# Plugins live on the runner and are only available to a certain set of first party actions.
plugin: 'checkout'
plugin: 'checkoutV1_1'