|
@@ -1,6 +1,6 @@
|
|
[](https://github.com/actions/checkout/actions/workflows/test.yml)
|
|
[](https://github.com/actions/checkout/actions/workflows/test.yml)
|
|
|
|
|
|
-# Checkout V3
|
|
|
|
|
|
+# Checkout V4
|
|
|
|
|
|
This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it.
|
|
This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it.
|
|
|
|
|
|
@@ -12,14 +12,14 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
|
|
|
|
|
|
# What's new
|
|
# What's new
|
|
|
|
|
|
-- Updated to the node16 runtime by default
|
|
|
|
- - This requires a minimum [Actions Runner](https://github.com/actions/runner/releases/tag/v2.285.0) version of v2.285.0 to run, which is by default available in GHES 3.4 or later.
|
|
|
|
|
|
+- Updated to the node20 runtime by default
|
|
|
|
+ - This requires a minimum [Actions Runner](https://github.com/actions/runner/releases/tag/v2.285.0) version of v2.308.0 to run, which is by default available in GHES 3.11 or later.
|
|
|
|
|
|
# Usage
|
|
# Usage
|
|
|
|
|
|
<!-- start usage -->
|
|
<!-- start usage -->
|
|
```yaml
|
|
```yaml
|
|
-- uses: actions/checkout@v3
|
|
|
|
|
|
+- uses: actions/checkout@v4
|
|
with:
|
|
with:
|
|
# Repository name with owner. For example, actions/checkout
|
|
# Repository name with owner. For example, actions/checkout
|
|
# Default: ${{ github.repository }}
|
|
# Default: ${{ github.repository }}
|
|
@@ -139,7 +139,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
|
|
## Fetch only the root files
|
|
## Fetch only the root files
|
|
|
|
|
|
```yaml
|
|
```yaml
|
|
-- uses: actions/checkout@v3
|
|
|
|
|
|
+- uses: actions/checkout@v4
|
|
with:
|
|
with:
|
|
sparse-checkout: .
|
|
sparse-checkout: .
|
|
```
|
|
```
|
|
@@ -147,7 +147,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
|
|
## Fetch only the root files and `.github` and `src` folder
|
|
## Fetch only the root files and `.github` and `src` folder
|
|
|
|
|
|
```yaml
|
|
```yaml
|
|
-- uses: actions/checkout@v3
|
|
|
|
|
|
+- uses: actions/checkout@v4
|
|
with:
|
|
with:
|
|
sparse-checkout: |
|
|
sparse-checkout: |
|
|
.github
|
|
.github
|
|
@@ -157,7 +157,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
|
|
## Fetch only a single file
|
|
## Fetch only a single file
|
|
|
|
|
|
```yaml
|
|
```yaml
|
|
-- uses: actions/checkout@v3
|
|
|
|
|
|
+- uses: actions/checkout@v4
|
|
with:
|
|
with:
|
|
sparse-checkout: |
|
|
sparse-checkout: |
|
|
README.md
|
|
README.md
|
|
@@ -167,7 +167,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
|
|
## Fetch all history for all tags and branches
|
|
## Fetch all history for all tags and branches
|
|
|
|
|
|
```yaml
|
|
```yaml
|
|
-- uses: actions/checkout@v3
|
|
|
|
|
|
+- uses: actions/checkout@v4
|
|
with:
|
|
with:
|
|
fetch-depth: 0
|
|
fetch-depth: 0
|
|
```
|
|
```
|
|
@@ -175,7 +175,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
|
|
## Checkout a different branch
|
|
## Checkout a different branch
|
|
|
|
|
|
```yaml
|
|
```yaml
|
|
-- uses: actions/checkout@v3
|
|
|
|
|
|
+- uses: actions/checkout@v4
|
|
with:
|
|
with:
|
|
ref: my-branch
|
|
ref: my-branch
|
|
```
|
|
```
|
|
@@ -183,7 +183,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
|
|
## Checkout HEAD^
|
|
## Checkout HEAD^
|
|
|
|
|
|
```yaml
|
|
```yaml
|
|
-- uses: actions/checkout@v3
|
|
|
|
|
|
+- uses: actions/checkout@v4
|
|
with:
|
|
with:
|
|
fetch-depth: 2
|
|
fetch-depth: 2
|
|
- run: git checkout HEAD^
|
|
- run: git checkout HEAD^
|
|
@@ -193,12 +193,12 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
|
|
|
|
|
|
```yaml
|
|
```yaml
|
|
- name: Checkout
|
|
- name: Checkout
|
|
- uses: actions/checkout@v3
|
|
|
|
|
|
+ uses: actions/checkout@v4
|
|
with:
|
|
with:
|
|
path: main
|
|
path: main
|
|
|
|
|
|
- name: Checkout tools repo
|
|
- name: Checkout tools repo
|
|
- uses: actions/checkout@v3
|
|
|
|
|
|
+ uses: actions/checkout@v4
|
|
with:
|
|
with:
|
|
repository: my-org/my-tools
|
|
repository: my-org/my-tools
|
|
path: my-tools
|
|
path: my-tools
|
|
@@ -209,10 +209,10 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
|
|
|
|
|
|
```yaml
|
|
```yaml
|
|
- name: Checkout
|
|
- name: Checkout
|
|
- uses: actions/checkout@v3
|
|
|
|
|
|
+ uses: actions/checkout@v4
|
|
|
|
|
|
- name: Checkout tools repo
|
|
- name: Checkout tools repo
|
|
- uses: actions/checkout@v3
|
|
|
|
|
|
+ uses: actions/checkout@v4
|
|
with:
|
|
with:
|
|
repository: my-org/my-tools
|
|
repository: my-org/my-tools
|
|
path: my-tools
|
|
path: my-tools
|
|
@@ -223,12 +223,12 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
|
|
|
|
|
|
```yaml
|
|
```yaml
|
|
- name: Checkout
|
|
- name: Checkout
|
|
- uses: actions/checkout@v3
|
|
|
|
|
|
+ uses: actions/checkout@v4
|
|
with:
|
|
with:
|
|
path: main
|
|
path: main
|
|
|
|
|
|
- name: Checkout private tools
|
|
- name: Checkout private tools
|
|
- uses: actions/checkout@v3
|
|
|
|
|
|
+ uses: actions/checkout@v4
|
|
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 your PAT
|
|
@@ -241,7 +241,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
|
|
## Checkout pull request HEAD commit instead of merge commit
|
|
## Checkout pull request HEAD commit instead of merge commit
|
|
|
|
|
|
```yaml
|
|
```yaml
|
|
-- uses: actions/checkout@v3
|
|
|
|
|
|
+- uses: actions/checkout@v4
|
|
with:
|
|
with:
|
|
ref: ${{ github.event.pull_request.head.sha }}
|
|
ref: ${{ github.event.pull_request.head.sha }}
|
|
```
|
|
```
|
|
@@ -257,7 +257,7 @@ jobs:
|
|
build:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
steps:
|
|
- - uses: actions/checkout@v3
|
|
|
|
|
|
+ - uses: actions/checkout@v4
|
|
```
|
|
```
|
|
|
|
|
|
## Push a commit using the built-in token
|
|
## Push a commit using the built-in token
|
|
@@ -268,7 +268,7 @@ jobs:
|
|
build:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
steps:
|
|
- - uses: actions/checkout@v3
|
|
|
|
|
|
+ - uses: actions/checkout@v4
|
|
- run: |
|
|
- run: |
|
|
date > generated.txt
|
|
date > generated.txt
|
|
git config user.name github-actions
|
|
git config user.name github-actions
|