actions/checkout
1
0
Fork 0
mirror of https://github.com/actions/checkout.git synced 2024-12-27 01:30:35 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Ariel Elkin 2021-12-15 10:17:09 +00:00 committed by GitHub
parent 230611dbd0
commit d03156b5b8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -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 # with the local git config, which enables your scripts to run authenticated git
# commands. The post-job step removes the PAT. # 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 # We recommend using a service account with the least permissions necessary. Also
# when generating a new PAT, select the least scopes necessary. # 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 # Whether to checkout submodules: `true` to checkout submodules or `recursive` to
# recursively checkout submodules. # recursively checkout submodules.
# #
# When the `ssh-key` input is not provided, SSH URLs beginning with # When neither the `ssh-key` nor the `token` inputs are provided, SSH URLs
# `git@github.com:` are converted to HTTPS. # beginning with `git@github.com:` are converted to HTTPS.
# #
# Default: false # Default: false
submodules: '' submodules: ''
@ -185,12 +188,19 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
uses: actions/checkout@v2 uses: actions/checkout@v2
with: with:
repository: my-org/my-private-tools 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 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 ## Checkout pull request HEAD commit instead of merge commit