Actions/checkout
0
Fork 0
mirror of https://github.com/actions/checkout.git synced 2025-10-31 16:23:36 +00:00
Code

Merge d03156b5b87293bfcac690d17511cb25c89bd3af into ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493

Browse Source
This commit is contained in:
Ariel Elkin 2025-08-20 00:06:42 +08:00 committed by GitHub
commit 62df2d86f9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
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

@ -59,6 +59,9 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
# 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.
#
@ -136,8 +139,8 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
# 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: ''
@ -275,12 +278,19 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
uses: actions/checkout@v5
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