mirror of
https://github.com/actions/checkout.git
synced 2024-11-14 05:26:32 +02:00
Update README.md
This commit is contained in:
parent
230611dbd0
commit
d03156b5b8
1 changed files with 14 additions and 4 deletions
18
README.md
18
README.md
|
@ -49,6 +49,9 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
|
|||
# with the local git config, which enables your scripts to run authenticated git
|
||||
# commands. The post-job step removes the PAT.
|
||||
#
|
||||
# If any of the submodules are private GitHub repos, pass in a PAT with read-access
|
||||
# to them.
|
||||
#
|
||||
# We recommend using a service account with the least permissions necessary. Also
|
||||
# when generating a new PAT, select the least scopes necessary.
|
||||
#
|
||||
|
@ -100,8 +103,8 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
|
|||
# Whether to checkout submodules: `true` to checkout submodules or `recursive` to
|
||||
# recursively checkout submodules.
|
||||
#
|
||||
# When the `ssh-key` input is not provided, SSH URLs beginning with
|
||||
# `git@github.com:` are converted to HTTPS.
|
||||
# When neither the `ssh-key` nor the `token` inputs are provided, SSH URLs
|
||||
# beginning with `git@github.com:` are converted to HTTPS.
|
||||
#
|
||||
# Default: false
|
||||
submodules: ''
|
||||
|
@ -185,12 +188,19 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
|
|||
uses: actions/checkout@v2
|
||||
with:
|
||||
repository: my-org/my-private-tools
|
||||
token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT
|
||||
token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains a PAT with read-access to this private repository
|
||||
path: my-tools
|
||||
```
|
||||
|
||||
> - `${{ github.token }}` is scoped to the current repository, so if you want to checkout a different 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 a repo and its private submodules
|
||||
|
||||
```yaml
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
submodules: true
|
||||
token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains a PAT with read-access to the private submodules
|
||||
```
|
||||
|
||||
## Checkout pull request HEAD commit instead of merge commit
|
||||
|
||||
|
|
Loading…
Reference in a new issue