mirror of
https://github.com/actions/checkout.git
synced 2026-07-08 19:03:47 +08:00
Compare commits
3 Commits
v5
...
62df2d86f9
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
62df2d86f9 | ||
|
|
ff7abcd0c3 | ||
|
|
d03156b5b8 |
27
README.md
27
README.md
@@ -2,7 +2,11 @@
|
||||
|
||||
# Checkout V5
|
||||
|
||||
Checkout v5 now supports Node.js 24
|
||||
## What's new
|
||||
|
||||
- Updated to the node24 runtime
|
||||
- This requires a minimum Actions Runner version of [v2.327.1](https://github.com/actions/runner/releases/tag/v2.327.1) to run.
|
||||
|
||||
|
||||
# Checkout V4
|
||||
|
||||
@@ -55,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.
|
||||
#
|
||||
@@ -132,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: ''
|
||||
@@ -154,9 +161,10 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
|
||||
# Scenarios
|
||||
|
||||
- [Checkout V5](#checkout-v5)
|
||||
- [What's new](#whats-new)
|
||||
- [Checkout V4](#checkout-v4)
|
||||
- [Note](#note)
|
||||
- [What's new](#whats-new)
|
||||
- [What's new](#whats-new-1)
|
||||
- [Usage](#usage)
|
||||
- [Scenarios](#scenarios)
|
||||
- [Fetch only the root files](#fetch-only-the-root-files)
|
||||
@@ -270,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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user