chore(deps): update actions/checkout action to v5 - #336
Conversation
|
bedrock debug - [puLL-Merge] - actions/[email protected] Diffdiff --git .github/workflows/check-dist.yml .github/workflows/check-dist.yml
index 53902eeb9..db3e37f2b 100644
--- .github/workflows/check-dist.yml
+++ .github/workflows/check-dist.yml
@@ -24,10 +24,10 @@ jobs:
steps:
- uses: actions/[email protected]
- - name: Set Node.js 20.x
+ - name: Set Node.js 24.x
uses: actions/setup-node@v4
with:
- node-version: 20.x
+ node-version: 24.x
- name: Install dependencies
run: npm ci
diff --git .github/workflows/test.yml .github/workflows/test.yml
index cde9f060e..e62ac3ba6 100644
--- .github/workflows/test.yml
+++ .github/workflows/test.yml
@@ -18,7 +18,7 @@ jobs:
steps:
- uses: actions/setup-node@v4
with:
- node-version: 20.x
+ node-version: 24.x
- uses: actions/[email protected]
- run: npm ci
- run: npm run build
diff --git .github/workflows/update-main-version.yml .github/workflows/update-main-version.yml
index 7bec7d5a8..643b954e4 100644
--- .github/workflows/update-main-version.yml
+++ .github/workflows/update-main-version.yml
@@ -11,6 +11,7 @@ on:
type: choice
description: The major version to update
options:
+ - v5
- v4
- v3
- v2
diff --git CHANGELOG.md CHANGELOG.md
index baf5c2d7e..ff8b4e7b0 100644
--- CHANGELOG.md
+++ CHANGELOG.md
@@ -1,5 +1,9 @@
# Changelog
+## V5.0.0
+* Update actions checkout to use node 24 by @salmanmkc in https://github.com/actions/checkout/pull/2226
+
+
## V4.3.0
* docs: update README.md by @motss in https://github.com/actions/checkout/pull/1971
* Add internal repos for checking out multiple repositories by @mouismail in https://github.com/actions/checkout/pull/1977
diff --git README.md README.md
index 8969446c3..f9175e995 100644
--- README.md
+++ README.md
@@ -1,5 +1,9 @@
[](https://github.com/actions/checkout/actions/workflows/test.yml)
+# Checkout V5
+
+Checkout v5 now supports Node.js 24
+
# Checkout V4
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/
<!-- start usage -->
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
# Repository name with owner. For example, actions/checkout
# Default: ${{ github.repository }}
@@ -149,24 +153,32 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
# Scenarios
-- [Fetch only the root files](#Fetch-only-the-root-files)
-- [Fetch only the root files and `.github` and `src` folder](#Fetch-only-the-root-files-and-github-and-src-folder)
-- [Fetch only a single file](#Fetch-only-a-single-file)
-- [Fetch all history for all tags and branches](#Fetch-all-history-for-all-tags-and-branches)
-- [Checkout a different branch](#Checkout-a-different-branch)
-- [Checkout HEAD^](#Checkout-HEAD)
-- [Checkout multiple repos (side by side)](#Checkout-multiple-repos-side-by-side)
-- [Checkout multiple repos (nested)](#Checkout-multiple-repos-nested)
-- [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
-- [Checkout pull request HEAD commit instead of merge commit](#Checkout-pull-request-HEAD-commit-instead-of-merge-commit)
-- [Checkout pull request on closed event](#Checkout-pull-request-on-closed-event)
-- [Push a commit using the built-in token](#Push-a-commit-using-the-built-in-token)
-- [Push a commit to a PR using the built-in token](#Push-a-commit-to-a-PR-using-the-built-in-token)
+- [Checkout V5](#checkout-v5)
+- [Checkout V4](#checkout-v4)
+ - [Note](#note)
+- [What's new](#whats-new)
+- [Usage](#usage)
+- [Scenarios](#scenarios)
+ - [Fetch only the root files](#fetch-only-the-root-files)
+ - [Fetch only the root files and `.github` and `src` folder](#fetch-only-the-root-files-and-github-and-src-folder)
+ - [Fetch only a single file](#fetch-only-a-single-file)
+ - [Fetch all history for all tags and branches](#fetch-all-history-for-all-tags-and-branches)
+ - [Checkout a different branch](#checkout-a-different-branch)
+ - [Checkout HEAD^](#checkout-head)
+ - [Checkout multiple repos (side by side)](#checkout-multiple-repos-side-by-side)
+ - [Checkout multiple repos (nested)](#checkout-multiple-repos-nested)
+ - [Checkout multiple repos (private)](#checkout-multiple-repos-private)
+ - [Checkout pull request HEAD commit instead of merge commit](#checkout-pull-request-head-commit-instead-of-merge-commit)
+ - [Checkout pull request on closed event](#checkout-pull-request-on-closed-event)
+ - [Push a commit using the built-in token](#push-a-commit-using-the-built-in-token)
+ - [Push a commit to a PR using the built-in token](#push-a-commit-to-a-pr-using-the-built-in-token)
+- [Recommended permissions](#recommended-permissions)
+- [License](#license)
## Fetch only the root files
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
sparse-checkout: .
```
@@ -174,7 +186,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Fetch only the root files and `.github` and `src` folder
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
sparse-checkout: |
.github
@@ -184,7 +196,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Fetch only a single file
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
sparse-checkout: |
README.md
@@ -194,7 +206,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Fetch all history for all tags and branches
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
fetch-depth: 0
```
@@ -202,7 +214,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Checkout a different branch
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
ref: my-branch
```
@@ -210,7 +222,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Checkout HEAD^
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
fetch-depth: 2
- run: git checkout HEAD^
@@ -220,12 +232,12 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
```yaml
- name: Checkout
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
path: main
- name: Checkout tools repo
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
repository: my-org/my-tools
path: my-tools
@@ -236,10 +248,10 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
```yaml
- name: Checkout
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
- name: Checkout tools repo
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
repository: my-org/my-tools
path: my-tools
@@ -250,12 +262,12 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
```yaml
- name: Checkout
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
path: main
- name: Checkout private tools
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
repository: my-org/my-private-tools
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/
## Checkout pull request HEAD commit instead of merge commit
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
ref: ${{ github.event.pull_request.head.sha }}
```
@@ -284,7 +296,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v4
+ - uses: actions/checkout@v5
```
## Push a commit using the built-in token
@@ -295,7 +307,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v4
+ - uses: actions/checkout@v5
- run: |
date > generated.txt
# Note: the following account information will not work on GHES
@@ -317,7 +329,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v4
+ - uses: actions/checkout@v5
with:
ref: ${{ github.head_ref }}
- run: |
diff --git action.yml action.yml
index 6842eb843..767c41649 100644
--- action.yml
+++ action.yml
@@ -104,6 +104,6 @@ outputs:
commit:
description: 'The commit SHA that was checked out'
runs:
- using: node20
+ using: node24
main: dist/index.js
post: dist/index.js
diff --git package.json package.json
index dbbaabbae..4b2b58a51 100644
--- package.json
+++ package.json
@@ -1,6 +1,6 @@
{
"name": "checkout",
- "version": "4.3.0",
+ "version": "5.0.0",
"description": "checkout action",
"main": "lib/main.js",
"scripts": {
@@ -37,7 +37,7 @@
},
"devDependencies": {
"@types/jest": "^29.5.12",
- "@types/node": "^20.12.12",
+ "@types/node": "^24.1.0",
"@types/uuid": "^9.0.8",
"@typescript-eslint/eslint-plugin": "^7.9.0",
"@typescript-eslint/parser": "^7.9.0",
diff --git src/misc/generate-docs.ts src/misc/generate-docs.ts
index 4b3c8ff52..6d4816f15 100644
--- src/misc/generate-docs.ts
+++ src/misc/generate-docs.ts
@@ -120,7 +120,7 @@ function updateUsage(
}
updateUsage(
- 'actions/checkout@v4',
+ 'actions/checkout@v5',
path.join(__dirname, '..', '..', 'action.yml'),
path.join(__dirname, '..', '..', 'README.md')
)
DescriptionThis PR updates the GitHub Actions Checkout action from v4 to v5, with the primary change being the migration from Node.js 20.x to Node.js 24.x. This represents a major version bump as indicated by the version number changes throughout the codebase. ChangesChanges
sequenceDiagram
participant Developer
participant Repository
participant CI
Developer->>Repository: Update Node.js version from 20.x to 24.x
Developer->>Repository: Update version references from v4 to v5
Developer->>Repository: Update package.json version to 5.0.0
Developer->>Repository: Update documentation with new Node.js 24 support
Repository->>CI: Run test workflow with Node.js 24.x
Repository->>CI: Run check-dist workflow with Node.js 24.x
CI->>Repository: Validate compatibility with Node.js 24
Repository->>Developer: PR ready for review
|
|
openai debug - [puLL-Merge] - actions/[email protected] Diffdiff --git .github/workflows/check-dist.yml .github/workflows/check-dist.yml
index 53902eeb9..db3e37f2b 100644
--- .github/workflows/check-dist.yml
+++ .github/workflows/check-dist.yml
@@ -24,10 +24,10 @@ jobs:
steps:
- uses: actions/[email protected]
- - name: Set Node.js 20.x
+ - name: Set Node.js 24.x
uses: actions/setup-node@v4
with:
- node-version: 20.x
+ node-version: 24.x
- name: Install dependencies
run: npm ci
diff --git .github/workflows/test.yml .github/workflows/test.yml
index cde9f060e..e62ac3ba6 100644
--- .github/workflows/test.yml
+++ .github/workflows/test.yml
@@ -18,7 +18,7 @@ jobs:
steps:
- uses: actions/setup-node@v4
with:
- node-version: 20.x
+ node-version: 24.x
- uses: actions/[email protected]
- run: npm ci
- run: npm run build
diff --git .github/workflows/update-main-version.yml .github/workflows/update-main-version.yml
index 7bec7d5a8..643b954e4 100644
--- .github/workflows/update-main-version.yml
+++ .github/workflows/update-main-version.yml
@@ -11,6 +11,7 @@ on:
type: choice
description: The major version to update
options:
+ - v5
- v4
- v3
- v2
diff --git CHANGELOG.md CHANGELOG.md
index baf5c2d7e..ff8b4e7b0 100644
--- CHANGELOG.md
+++ CHANGELOG.md
@@ -1,5 +1,9 @@
# Changelog
+## V5.0.0
+* Update actions checkout to use node 24 by @salmanmkc in https://github.com/actions/checkout/pull/2226
+
+
## V4.3.0
* docs: update README.md by @motss in https://github.com/actions/checkout/pull/1971
* Add internal repos for checking out multiple repositories by @mouismail in https://github.com/actions/checkout/pull/1977
diff --git README.md README.md
index 8969446c3..f9175e995 100644
--- README.md
+++ README.md
@@ -1,5 +1,9 @@
[](https://github.com/actions/checkout/actions/workflows/test.yml)
+# Checkout V5
+
+Checkout v5 now supports Node.js 24
+
# Checkout V4
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/
<!-- start usage -->
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
# Repository name with owner. For example, actions/checkout
# Default: ${{ github.repository }}
@@ -149,24 +153,32 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
# Scenarios
-- [Fetch only the root files](#Fetch-only-the-root-files)
-- [Fetch only the root files and `.github` and `src` folder](#Fetch-only-the-root-files-and-github-and-src-folder)
-- [Fetch only a single file](#Fetch-only-a-single-file)
-- [Fetch all history for all tags and branches](#Fetch-all-history-for-all-tags-and-branches)
-- [Checkout a different branch](#Checkout-a-different-branch)
-- [Checkout HEAD^](#Checkout-HEAD)
-- [Checkout multiple repos (side by side)](#Checkout-multiple-repos-side-by-side)
-- [Checkout multiple repos (nested)](#Checkout-multiple-repos-nested)
-- [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
-- [Checkout pull request HEAD commit instead of merge commit](#Checkout-pull-request-HEAD-commit-instead-of-merge-commit)
-- [Checkout pull request on closed event](#Checkout-pull-request-on-closed-event)
-- [Push a commit using the built-in token](#Push-a-commit-using-the-built-in-token)
-- [Push a commit to a PR using the built-in token](#Push-a-commit-to-a-PR-using-the-built-in-token)
+- [Checkout V5](#checkout-v5)
+- [Checkout V4](#checkout-v4)
+ - [Note](#note)
+- [What's new](#whats-new)
+- [Usage](#usage)
+- [Scenarios](#scenarios)
+ - [Fetch only the root files](#fetch-only-the-root-files)
+ - [Fetch only the root files and `.github` and `src` folder](#fetch-only-the-root-files-and-github-and-src-folder)
+ - [Fetch only a single file](#fetch-only-a-single-file)
+ - [Fetch all history for all tags and branches](#fetch-all-history-for-all-tags-and-branches)
+ - [Checkout a different branch](#checkout-a-different-branch)
+ - [Checkout HEAD^](#checkout-head)
+ - [Checkout multiple repos (side by side)](#checkout-multiple-repos-side-by-side)
+ - [Checkout multiple repos (nested)](#checkout-multiple-repos-nested)
+ - [Checkout multiple repos (private)](#checkout-multiple-repos-private)
+ - [Checkout pull request HEAD commit instead of merge commit](#checkout-pull-request-head-commit-instead-of-merge-commit)
+ - [Checkout pull request on closed event](#checkout-pull-request-on-closed-event)
+ - [Push a commit using the built-in token](#push-a-commit-using-the-built-in-token)
+ - [Push a commit to a PR using the built-in token](#push-a-commit-to-a-pr-using-the-built-in-token)
+- [Recommended permissions](#recommended-permissions)
+- [License](#license)
## Fetch only the root files
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
sparse-checkout: .
```
@@ -174,7 +186,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Fetch only the root files and `.github` and `src` folder
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
sparse-checkout: |
.github
@@ -184,7 +196,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Fetch only a single file
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
sparse-checkout: |
README.md
@@ -194,7 +206,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Fetch all history for all tags and branches
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
fetch-depth: 0
```
@@ -202,7 +214,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Checkout a different branch
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
ref: my-branch
```
@@ -210,7 +222,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Checkout HEAD^
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
fetch-depth: 2
- run: git checkout HEAD^
@@ -220,12 +232,12 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
```yaml
- name: Checkout
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
path: main
- name: Checkout tools repo
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
repository: my-org/my-tools
path: my-tools
@@ -236,10 +248,10 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
```yaml
- name: Checkout
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
- name: Checkout tools repo
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
repository: my-org/my-tools
path: my-tools
@@ -250,12 +262,12 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
```yaml
- name: Checkout
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
path: main
- name: Checkout private tools
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
repository: my-org/my-private-tools
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/
## Checkout pull request HEAD commit instead of merge commit
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
ref: ${{ github.event.pull_request.head.sha }}
```
@@ -284,7 +296,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v4
+ - uses: actions/checkout@v5
```
## Push a commit using the built-in token
@@ -295,7 +307,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v4
+ - uses: actions/checkout@v5
- run: |
date > generated.txt
# Note: the following account information will not work on GHES
@@ -317,7 +329,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v4
+ - uses: actions/checkout@v5
with:
ref: ${{ github.head_ref }}
- run: |
diff --git action.yml action.yml
index 6842eb843..767c41649 100644
--- action.yml
+++ action.yml
@@ -104,6 +104,6 @@ outputs:
commit:
description: 'The commit SHA that was checked out'
runs:
- using: node20
+ using: node24
main: dist/index.js
post: dist/index.js
diff --git package.json package.json
index dbbaabbae..4b2b58a51 100644
--- package.json
+++ package.json
@@ -1,6 +1,6 @@
{
"name": "checkout",
- "version": "4.3.0",
+ "version": "5.0.0",
"description": "checkout action",
"main": "lib/main.js",
"scripts": {
@@ -37,7 +37,7 @@
},
"devDependencies": {
"@types/jest": "^29.5.12",
- "@types/node": "^20.12.12",
+ "@types/node": "^24.1.0",
"@types/uuid": "^9.0.8",
"@typescript-eslint/eslint-plugin": "^7.9.0",
"@typescript-eslint/parser": "^7.9.0",
diff --git src/misc/generate-docs.ts src/misc/generate-docs.ts
index 4b3c8ff52..6d4816f15 100644
--- src/misc/generate-docs.ts
+++ src/misc/generate-docs.ts
@@ -120,7 +120,7 @@ function updateUsage(
}
updateUsage(
- 'actions/checkout@v4',
+ 'actions/checkout@v5',
path.join(__dirname, '..', '..', 'action.yml'),
path.join(__dirname, '..', '..', 'README.md')
)
DescriptionThis pull request upgrades the Possible Issues
Security HotspotsNone identified. Privacy HotspotsNone identified. ChangesChanges
sequenceDiagram
participant User as User
participant GitHubActions as GitHub Actions
participant CI as Continuous Integration
participant Repo as Repository
User->>GitHubActions: Push code changes
GitHubActions->>CI: Trigger workflows (checkout, test)
CI->>Repo: Checkout code with Node.js 24
CI->>Repo: Run tests and build with Node.js 24
CI->>GitHubActions: Report status of build and tests
GitHubActions->>User: Provide workflow status
|
|
anthropic debug - [puLL-Merge] - actions/[email protected] Diffdiff --git .github/workflows/check-dist.yml .github/workflows/check-dist.yml
index 53902eeb9..db3e37f2b 100644
--- .github/workflows/check-dist.yml
+++ .github/workflows/check-dist.yml
@@ -24,10 +24,10 @@ jobs:
steps:
- uses: actions/[email protected]
- - name: Set Node.js 20.x
+ - name: Set Node.js 24.x
uses: actions/setup-node@v4
with:
- node-version: 20.x
+ node-version: 24.x
- name: Install dependencies
run: npm ci
diff --git .github/workflows/test.yml .github/workflows/test.yml
index cde9f060e..e62ac3ba6 100644
--- .github/workflows/test.yml
+++ .github/workflows/test.yml
@@ -18,7 +18,7 @@ jobs:
steps:
- uses: actions/setup-node@v4
with:
- node-version: 20.x
+ node-version: 24.x
- uses: actions/[email protected]
- run: npm ci
- run: npm run build
diff --git .github/workflows/update-main-version.yml .github/workflows/update-main-version.yml
index 7bec7d5a8..643b954e4 100644
--- .github/workflows/update-main-version.yml
+++ .github/workflows/update-main-version.yml
@@ -11,6 +11,7 @@ on:
type: choice
description: The major version to update
options:
+ - v5
- v4
- v3
- v2
diff --git CHANGELOG.md CHANGELOG.md
index baf5c2d7e..ff8b4e7b0 100644
--- CHANGELOG.md
+++ CHANGELOG.md
@@ -1,5 +1,9 @@
# Changelog
+## V5.0.0
+* Update actions checkout to use node 24 by @salmanmkc in https://github.com/actions/checkout/pull/2226
+
+
## V4.3.0
* docs: update README.md by @motss in https://github.com/actions/checkout/pull/1971
* Add internal repos for checking out multiple repositories by @mouismail in https://github.com/actions/checkout/pull/1977
diff --git README.md README.md
index 8969446c3..f9175e995 100644
--- README.md
+++ README.md
@@ -1,5 +1,9 @@
[](https://github.com/actions/checkout/actions/workflows/test.yml)
+# Checkout V5
+
+Checkout v5 now supports Node.js 24
+
# Checkout V4
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/
<!-- start usage -->
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
# Repository name with owner. For example, actions/checkout
# Default: ${{ github.repository }}
@@ -149,24 +153,32 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
# Scenarios
-- [Fetch only the root files](#Fetch-only-the-root-files)
-- [Fetch only the root files and `.github` and `src` folder](#Fetch-only-the-root-files-and-github-and-src-folder)
-- [Fetch only a single file](#Fetch-only-a-single-file)
-- [Fetch all history for all tags and branches](#Fetch-all-history-for-all-tags-and-branches)
-- [Checkout a different branch](#Checkout-a-different-branch)
-- [Checkout HEAD^](#Checkout-HEAD)
-- [Checkout multiple repos (side by side)](#Checkout-multiple-repos-side-by-side)
-- [Checkout multiple repos (nested)](#Checkout-multiple-repos-nested)
-- [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
-- [Checkout pull request HEAD commit instead of merge commit](#Checkout-pull-request-HEAD-commit-instead-of-merge-commit)
-- [Checkout pull request on closed event](#Checkout-pull-request-on-closed-event)
-- [Push a commit using the built-in token](#Push-a-commit-using-the-built-in-token)
-- [Push a commit to a PR using the built-in token](#Push-a-commit-to-a-PR-using-the-built-in-token)
+- [Checkout V5](#checkout-v5)
+- [Checkout V4](#checkout-v4)
+ - [Note](#note)
+- [What's new](#whats-new)
+- [Usage](#usage)
+- [Scenarios](#scenarios)
+ - [Fetch only the root files](#fetch-only-the-root-files)
+ - [Fetch only the root files and `.github` and `src` folder](#fetch-only-the-root-files-and-github-and-src-folder)
+ - [Fetch only a single file](#fetch-only-a-single-file)
+ - [Fetch all history for all tags and branches](#fetch-all-history-for-all-tags-and-branches)
+ - [Checkout a different branch](#checkout-a-different-branch)
+ - [Checkout HEAD^](#checkout-head)
+ - [Checkout multiple repos (side by side)](#checkout-multiple-repos-side-by-side)
+ - [Checkout multiple repos (nested)](#checkout-multiple-repos-nested)
+ - [Checkout multiple repos (private)](#checkout-multiple-repos-private)
+ - [Checkout pull request HEAD commit instead of merge commit](#checkout-pull-request-head-commit-instead-of-merge-commit)
+ - [Checkout pull request on closed event](#checkout-pull-request-on-closed-event)
+ - [Push a commit using the built-in token](#push-a-commit-using-the-built-in-token)
+ - [Push a commit to a PR using the built-in token](#push-a-commit-to-a-pr-using-the-built-in-token)
+- [Recommended permissions](#recommended-permissions)
+- [License](#license)
## Fetch only the root files
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
sparse-checkout: .
```
@@ -174,7 +186,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Fetch only the root files and `.github` and `src` folder
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
sparse-checkout: |
.github
@@ -184,7 +196,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Fetch only a single file
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
sparse-checkout: |
README.md
@@ -194,7 +206,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Fetch all history for all tags and branches
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
fetch-depth: 0
```
@@ -202,7 +214,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Checkout a different branch
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
ref: my-branch
```
@@ -210,7 +222,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
## Checkout HEAD^
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
fetch-depth: 2
- run: git checkout HEAD^
@@ -220,12 +232,12 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
```yaml
- name: Checkout
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
path: main
- name: Checkout tools repo
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
repository: my-org/my-tools
path: my-tools
@@ -236,10 +248,10 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
```yaml
- name: Checkout
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
- name: Checkout tools repo
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
repository: my-org/my-tools
path: my-tools
@@ -250,12 +262,12 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
```yaml
- name: Checkout
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
path: main
- name: Checkout private tools
- uses: actions/checkout@v4
+ uses: actions/checkout@v5
with:
repository: my-org/my-private-tools
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/
## Checkout pull request HEAD commit instead of merge commit
```yaml
-- uses: actions/checkout@v4
+- uses: actions/checkout@v5
with:
ref: ${{ github.event.pull_request.head.sha }}
```
@@ -284,7 +296,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v4
+ - uses: actions/checkout@v5
```
## Push a commit using the built-in token
@@ -295,7 +307,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v4
+ - uses: actions/checkout@v5
- run: |
date > generated.txt
# Note: the following account information will not work on GHES
@@ -317,7 +329,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v4
+ - uses: actions/checkout@v5
with:
ref: ${{ github.head_ref }}
- run: |
diff --git action.yml action.yml
index 6842eb843..767c41649 100644
--- action.yml
+++ action.yml
@@ -104,6 +104,6 @@ outputs:
commit:
description: 'The commit SHA that was checked out'
runs:
- using: node20
+ using: node24
main: dist/index.js
post: dist/index.js
diff --git package.json package.json
index dbbaabbae..4b2b58a51 100644
--- package.json
+++ package.json
@@ -1,6 +1,6 @@
{
"name": "checkout",
- "version": "4.3.0",
+ "version": "5.0.0",
"description": "checkout action",
"main": "lib/main.js",
"scripts": {
@@ -37,7 +37,7 @@
},
"devDependencies": {
"@types/jest": "^29.5.12",
- "@types/node": "^20.12.12",
+ "@types/node": "^24.1.0",
"@types/uuid": "^9.0.8",
"@typescript-eslint/eslint-plugin": "^7.9.0",
"@typescript-eslint/parser": "^7.9.0",
diff --git src/misc/generate-docs.ts src/misc/generate-docs.ts
index 4b3c8ff52..6d4816f15 100644
--- src/misc/generate-docs.ts
+++ src/misc/generate-docs.ts
@@ -120,7 +120,7 @@ function updateUsage(
}
updateUsage(
- 'actions/checkout@v4',
+ 'actions/checkout@v5',
path.join(__dirname, '..', '..', 'action.yml'),
path.join(__dirname, '..', '..', 'README.md')
)
DescriptionThis PR upgrades the
Possible Issues
ChangesChangesWorkflow Files (
Version Management (
Documentation (
Documentation (
Action Configuration (
Package Configuration (
Code Generation (
sequenceDiagram
participant Dev as Developer
participant GHA as GitHub Actions
participant Action as Checkout Action (v5)
participant Runtime as Node.js 24 Runtime
Dev->>GHA: Push code / Trigger workflow
GHA->>Action: Execute actions/checkout@v5
Action->>Runtime: Initialize on Node.js 24
Runtime->>Action: Runtime ready
Action->>Action: Parse inputs (repo, ref, token, etc.)
Action->>GHA: Execute git operations
GHA->>Action: Repository checked out
Action->>Runtime: Complete execution
Runtime->>GHA: Return success/failure
GHA->>Dev: Workflow continues with checked out code
|
This PR contains the following updates:
v4.3.0->v5.0.0Release Notes
actions/checkout (actions/checkout)
v5.0.0Compare Source
What's Changed
v2.327.1
Release Notes
Make sure your runner is updated to this version or newer to use this release.
Full Changelog: actions/checkout@v4...v5.0.0
Configuration
📅 Schedule: Branch creation - Tuesday through Thursday ( * * * * 2-4 ) (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.