Skip to content

Commit 08c6903

Browse files
authored
Prepare v5.0.0 release (#2238)
1 parent 9f26565 commit 08c6903

File tree

6 files changed

+51
-34
lines changed

6 files changed

+51
-34
lines changed

.github/workflows/update-main-version.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ on:
1111
type: choice
1212
description: The major version to update
1313
options:
14+
- v5
1415
- v4
1516
- v3
1617
- v2

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## V5.0.0
4+
* Update actions checkout to use node 24 by @salmanmkc in https://github.com/actions/checkout/pull/2226
5+
6+
37
## V4.3.0
48
* docs: update README.md by @motss in https://github.com/actions/checkout/pull/1971
59
* Add internal repos for checking out multiple repositories by @mouismail in https://github.com/actions/checkout/pull/1977

README.md

Lines changed: 42 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
[![Build and Test](https://github.com/actions/checkout/actions/workflows/test.yml/badge.svg)](https://github.com/actions/checkout/actions/workflows/test.yml)
22

3+
# Checkout V5
4+
5+
Checkout v5 now supports Node.js 24
6+
37
# Checkout V4
48

59
This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it.
@@ -36,7 +40,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
3640

3741
<!-- start usage -->
3842
```yaml
39-
- uses: actions/checkout@v4
43+
- uses: actions/checkout@v5
4044
with:
4145
# Repository name with owner. For example, actions/checkout
4246
# Default: ${{ github.repository }}
@@ -149,32 +153,40 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
149153
150154
# Scenarios
151155
152-
- [Fetch only the root files](#Fetch-only-the-root-files)
153-
- [Fetch only the root files and `.github` and `src` folder](#Fetch-only-the-root-files-and-github-and-src-folder)
154-
- [Fetch only a single file](#Fetch-only-a-single-file)
155-
- [Fetch all history for all tags and branches](#Fetch-all-history-for-all-tags-and-branches)
156-
- [Checkout a different branch](#Checkout-a-different-branch)
157-
- [Checkout HEAD^](#Checkout-HEAD)
158-
- [Checkout multiple repos (side by side)](#Checkout-multiple-repos-side-by-side)
159-
- [Checkout multiple repos (nested)](#Checkout-multiple-repos-nested)
160-
- [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
161-
- [Checkout pull request HEAD commit instead of merge commit](#Checkout-pull-request-HEAD-commit-instead-of-merge-commit)
162-
- [Checkout pull request on closed event](#Checkout-pull-request-on-closed-event)
163-
- [Push a commit using the built-in token](#Push-a-commit-using-the-built-in-token)
164-
- [Push a commit to a PR using the built-in token](#Push-a-commit-to-a-PR-using-the-built-in-token)
156+
- [Checkout V5](#checkout-v5)
157+
- [Checkout V4](#checkout-v4)
158+
- [Note](#note)
159+
- [What's new](#whats-new)
160+
- [Usage](#usage)
161+
- [Scenarios](#scenarios)
162+
- [Fetch only the root files](#fetch-only-the-root-files)
163+
- [Fetch only the root files and `.github` and `src` folder](#fetch-only-the-root-files-and-github-and-src-folder)
164+
- [Fetch only a single file](#fetch-only-a-single-file)
165+
- [Fetch all history for all tags and branches](#fetch-all-history-for-all-tags-and-branches)
166+
- [Checkout a different branch](#checkout-a-different-branch)
167+
- [Checkout HEAD^](#checkout-head)
168+
- [Checkout multiple repos (side by side)](#checkout-multiple-repos-side-by-side)
169+
- [Checkout multiple repos (nested)](#checkout-multiple-repos-nested)
170+
- [Checkout multiple repos (private)](#checkout-multiple-repos-private)
171+
- [Checkout pull request HEAD commit instead of merge commit](#checkout-pull-request-head-commit-instead-of-merge-commit)
172+
- [Checkout pull request on closed event](#checkout-pull-request-on-closed-event)
173+
- [Push a commit using the built-in token](#push-a-commit-using-the-built-in-token)
174+
- [Push a commit to a PR using the built-in token](#push-a-commit-to-a-pr-using-the-built-in-token)
175+
- [Recommended permissions](#recommended-permissions)
176+
- [License](#license)
165177

166178
## Fetch only the root files
167179

168180
```yaml
169-
- uses: actions/checkout@v4
181+
- uses: actions/checkout@v5
170182
with:
171183
sparse-checkout: .
172184
```
173185

174186
## Fetch only the root files and `.github` and `src` folder
175187

176188
```yaml
177-
- uses: actions/checkout@v4
189+
- uses: actions/checkout@v5
178190
with:
179191
sparse-checkout: |
180192
.github
@@ -184,7 +196,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
184196
## Fetch only a single file
185197

186198
```yaml
187-
- uses: actions/checkout@v4
199+
- uses: actions/checkout@v5
188200
with:
189201
sparse-checkout: |
190202
README.md
@@ -194,23 +206,23 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
194206
## Fetch all history for all tags and branches
195207

196208
```yaml
197-
- uses: actions/checkout@v4
209+
- uses: actions/checkout@v5
198210
with:
199211
fetch-depth: 0
200212
```
201213

202214
## Checkout a different branch
203215

204216
```yaml
205-
- uses: actions/checkout@v4
217+
- uses: actions/checkout@v5
206218
with:
207219
ref: my-branch
208220
```
209221

210222
## Checkout HEAD^
211223

212224
```yaml
213-
- uses: actions/checkout@v4
225+
- uses: actions/checkout@v5
214226
with:
215227
fetch-depth: 2
216228
- run: git checkout HEAD^
@@ -220,12 +232,12 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
220232

221233
```yaml
222234
- name: Checkout
223-
uses: actions/checkout@v4
235+
uses: actions/checkout@v5
224236
with:
225237
path: main
226238
227239
- name: Checkout tools repo
228-
uses: actions/checkout@v4
240+
uses: actions/checkout@v5
229241
with:
230242
repository: my-org/my-tools
231243
path: my-tools
@@ -236,10 +248,10 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
236248

237249
```yaml
238250
- name: Checkout
239-
uses: actions/checkout@v4
251+
uses: actions/checkout@v5
240252
241253
- name: Checkout tools repo
242-
uses: actions/checkout@v4
254+
uses: actions/checkout@v5
243255
with:
244256
repository: my-org/my-tools
245257
path: my-tools
@@ -250,12 +262,12 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
250262

251263
```yaml
252264
- name: Checkout
253-
uses: actions/checkout@v4
265+
uses: actions/checkout@v5
254266
with:
255267
path: main
256268
257269
- name: Checkout private tools
258-
uses: actions/checkout@v4
270+
uses: actions/checkout@v5
259271
with:
260272
repository: my-org/my-private-tools
261273
token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT
@@ -268,7 +280,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
268280
## Checkout pull request HEAD commit instead of merge commit
269281

270282
```yaml
271-
- uses: actions/checkout@v4
283+
- uses: actions/checkout@v5
272284
with:
273285
ref: ${{ github.event.pull_request.head.sha }}
274286
```
@@ -284,7 +296,7 @@ jobs:
284296
build:
285297
runs-on: ubuntu-latest
286298
steps:
287-
- uses: actions/checkout@v4
299+
- uses: actions/checkout@v5
288300
```
289301

290302
## Push a commit using the built-in token
@@ -295,7 +307,7 @@ jobs:
295307
build:
296308
runs-on: ubuntu-latest
297309
steps:
298-
- uses: actions/checkout@v4
310+
- uses: actions/checkout@v5
299311
- run: |
300312
date > generated.txt
301313
# Note: the following account information will not work on GHES
@@ -317,7 +329,7 @@ jobs:
317329
build:
318330
runs-on: ubuntu-latest
319331
steps:
320-
- uses: actions/checkout@v4
332+
- uses: actions/checkout@v5
321333
with:
322334
ref: ${{ github.head_ref }}
323335
- run: |

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "checkout",
3-
"version": "4.3.0",
3+
"version": "5.0.0",
44
"description": "checkout action",
55
"main": "lib/main.js",
66
"scripts": {

src/misc/generate-docs.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ function updateUsage(
120120
}
121121

122122
updateUsage(
123-
'actions/checkout@v4',
123+
'actions/checkout@v5',
124124
path.join(__dirname, '..', '..', 'action.yml'),
125125
path.join(__dirname, '..', '..', 'README.md')
126126
)

0 commit comments

Comments
 (0)