mirror of
				https://github.com/actions/checkout.git
				synced 2025-11-04 15:58:09 +08:00 
			
		
		
		
	Compare commits
	
		
			3 Commits
		
	
	
		
			v4.2.2
			...
			dependabot
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 
						 | 
					65935fcf40 | ||
| 
						 | 
					cbb722410c | ||
| 
						 | 
					3b9b8c884f | 
							
								
								
									
										30
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										30
									
								
								README.md
									
									
									
									
									
								
							@@ -143,6 +143,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
 | 
				
			|||||||
- [Checkout pull request HEAD commit instead of merge commit](#Checkout-pull-request-HEAD-commit-instead-of-merge-commit)
 | 
					- [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)
 | 
					- [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 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)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Fetch only the root files
 | 
					## Fetch only the root files
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -211,7 +212,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
 | 
				
			|||||||
    repository: my-org/my-tools
 | 
					    repository: my-org/my-tools
 | 
				
			||||||
    path: my-tools
 | 
					    path: my-tools
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
> - If your secondary repository is private you will need to add the option noted in [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
 | 
					> - If your secondary repository is private or internal you will need to add the option noted in [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Checkout multiple repos (nested)
 | 
					## Checkout multiple repos (nested)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -225,7 +226,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
 | 
				
			|||||||
    repository: my-org/my-tools
 | 
					    repository: my-org/my-tools
 | 
				
			||||||
    path: my-tools
 | 
					    path: my-tools
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
> - If your secondary repository is private you will need to add the option noted in [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
 | 
					> - If your secondary repository is private or internal you will need to add the option noted in [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Checkout multiple repos (private)
 | 
					## Checkout multiple repos (private)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -288,6 +289,31 @@ jobs:
 | 
				
			|||||||
```
 | 
					```
 | 
				
			||||||
*NOTE:* The user email is `{user.id}+{user.login}@users.noreply.github.com`. See users API: https://api.github.com/users/github-actions%5Bbot%5D
 | 
					*NOTE:* The user email is `{user.id}+{user.login}@users.noreply.github.com`. See users API: https://api.github.com/users/github-actions%5Bbot%5D
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Push a commit to a PR using the built-in token
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					In a pull request trigger, `ref` is required as GitHub Actions checks out in detached HEAD mode, meaning it doesn’t check out your branch by default.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```yaml
 | 
				
			||||||
 | 
					on: pull_request
 | 
				
			||||||
 | 
					jobs:
 | 
				
			||||||
 | 
					  build:
 | 
				
			||||||
 | 
					    runs-on: ubuntu-latest
 | 
				
			||||||
 | 
					    steps:
 | 
				
			||||||
 | 
					      - uses: actions/checkout@v4
 | 
				
			||||||
 | 
					        with:
 | 
				
			||||||
 | 
					          ref: ${{ github.head_ref }}
 | 
				
			||||||
 | 
					      - run: |
 | 
				
			||||||
 | 
					          date > generated.txt
 | 
				
			||||||
 | 
					          # Note: the following account information will not work on GHES
 | 
				
			||||||
 | 
					          git config user.name "github-actions[bot]"
 | 
				
			||||||
 | 
					          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
 | 
				
			||||||
 | 
					          git add .
 | 
				
			||||||
 | 
					          git commit -m "generated"
 | 
				
			||||||
 | 
					          git push
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					*NOTE:* The user email is `{user.id}+{user.login}@users.noreply.github.com`. See users API: https://api.github.com/users/github-actions%5Bbot%5D
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# License
 | 
					# License
 | 
				
			||||||
 | 
					
 | 
				
			||||||
The scripts and documentation in this project are released under the [MIT License](LICENSE)
 | 
					The scripts and documentation in this project are released under the [MIT License](LICENSE)
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										66
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										66
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							@@ -9,7 +9,7 @@
 | 
				
			|||||||
      "version": "4.2.2",
 | 
					      "version": "4.2.2",
 | 
				
			||||||
      "license": "MIT",
 | 
					      "license": "MIT",
 | 
				
			||||||
      "dependencies": {
 | 
					      "dependencies": {
 | 
				
			||||||
        "@actions/core": "^1.10.1",
 | 
					        "@actions/core": "^1.11.1",
 | 
				
			||||||
        "@actions/exec": "^1.1.1",
 | 
					        "@actions/exec": "^1.1.1",
 | 
				
			||||||
        "@actions/github": "^6.0.0",
 | 
					        "@actions/github": "^6.0.0",
 | 
				
			||||||
        "@actions/io": "^1.1.3",
 | 
					        "@actions/io": "^1.1.3",
 | 
				
			||||||
@@ -17,21 +17,21 @@
 | 
				
			|||||||
        "uuid": "^9.0.1"
 | 
					        "uuid": "^9.0.1"
 | 
				
			||||||
      },
 | 
					      },
 | 
				
			||||||
      "devDependencies": {
 | 
					      "devDependencies": {
 | 
				
			||||||
        "@types/jest": "^29.5.12",
 | 
					        "@types/jest": "^29.5.14",
 | 
				
			||||||
        "@types/node": "^20.12.12",
 | 
					        "@types/node": "^20.12.12",
 | 
				
			||||||
        "@types/uuid": "^9.0.8",
 | 
					        "@types/uuid": "^9.0.8",
 | 
				
			||||||
        "@typescript-eslint/eslint-plugin": "^7.9.0",
 | 
					        "@typescript-eslint/eslint-plugin": "^7.9.0",
 | 
				
			||||||
        "@typescript-eslint/parser": "^7.9.0",
 | 
					        "@typescript-eslint/parser": "^7.9.0",
 | 
				
			||||||
        "@vercel/ncc": "^0.38.1",
 | 
					        "@vercel/ncc": "^0.38.3",
 | 
				
			||||||
        "eslint": "^8.57.0",
 | 
					        "eslint": "^8.57.0",
 | 
				
			||||||
        "eslint-plugin-github": "^4.10.2",
 | 
					        "eslint-plugin-github": "^4.10.2",
 | 
				
			||||||
        "eslint-plugin-jest": "^28.8.2",
 | 
					        "eslint-plugin-jest": "^28.9.0",
 | 
				
			||||||
        "jest": "^29.7.0",
 | 
					        "jest": "^29.7.0",
 | 
				
			||||||
        "jest-circus": "^29.7.0",
 | 
					        "jest-circus": "^29.7.0",
 | 
				
			||||||
        "js-yaml": "^4.1.0",
 | 
					        "js-yaml": "^4.1.0",
 | 
				
			||||||
        "prettier": "^3.3.3",
 | 
					        "prettier": "^3.4.1",
 | 
				
			||||||
        "ts-jest": "^29.2.5",
 | 
					        "ts-jest": "^29.2.5",
 | 
				
			||||||
        "typescript": "^5.5.4"
 | 
					        "typescript": "^5.7.2"
 | 
				
			||||||
      }
 | 
					      }
 | 
				
			||||||
    },
 | 
					    },
 | 
				
			||||||
    "node_modules/@aashutoshrathi/word-wrap": {
 | 
					    "node_modules/@aashutoshrathi/word-wrap": {
 | 
				
			||||||
@@ -44,20 +44,13 @@
 | 
				
			|||||||
      }
 | 
					      }
 | 
				
			||||||
    },
 | 
					    },
 | 
				
			||||||
    "node_modules/@actions/core": {
 | 
					    "node_modules/@actions/core": {
 | 
				
			||||||
      "version": "1.10.1",
 | 
					      "version": "1.11.1",
 | 
				
			||||||
      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.1.tgz",
 | 
					      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.11.1.tgz",
 | 
				
			||||||
      "integrity": "sha512-3lBR9EDAY+iYIpTnTIXmWcNbX3T2kCkAEQGIQx4NVQ0575nk2k3GRZDTPQG+vVtS2izSLmINlxXf0uLtnrTP+g==",
 | 
					      "integrity": "sha512-hXJCSrkwfA46Vd9Z3q4cpEpHB1rL5NG04+/rbqW9d3+CSvtB1tYe8UTpAlixa1vj0m/ULglfEK2UKxMGxCxv5A==",
 | 
				
			||||||
 | 
					      "license": "MIT",
 | 
				
			||||||
      "dependencies": {
 | 
					      "dependencies": {
 | 
				
			||||||
        "@actions/http-client": "^2.0.1",
 | 
					        "@actions/exec": "^1.1.1",
 | 
				
			||||||
        "uuid": "^8.3.2"
 | 
					        "@actions/http-client": "^2.0.1"
 | 
				
			||||||
      }
 | 
					 | 
				
			||||||
    },
 | 
					 | 
				
			||||||
    "node_modules/@actions/core/node_modules/uuid": {
 | 
					 | 
				
			||||||
      "version": "8.3.2",
 | 
					 | 
				
			||||||
      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
 | 
					 | 
				
			||||||
      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==",
 | 
					 | 
				
			||||||
      "bin": {
 | 
					 | 
				
			||||||
        "uuid": "dist/bin/uuid"
 | 
					 | 
				
			||||||
      }
 | 
					      }
 | 
				
			||||||
    },
 | 
					    },
 | 
				
			||||||
    "node_modules/@actions/exec": {
 | 
					    "node_modules/@actions/exec": {
 | 
				
			||||||
@@ -1572,10 +1565,11 @@
 | 
				
			|||||||
      }
 | 
					      }
 | 
				
			||||||
    },
 | 
					    },
 | 
				
			||||||
    "node_modules/@types/jest": {
 | 
					    "node_modules/@types/jest": {
 | 
				
			||||||
      "version": "29.5.12",
 | 
					      "version": "29.5.14",
 | 
				
			||||||
      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.12.tgz",
 | 
					      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.14.tgz",
 | 
				
			||||||
      "integrity": "sha512-eDC8bTvT/QhYdxJAulQikueigY5AsdBRH2yDKW3yveW7svY3+DzN84/2NUgkw10RTiJbWqZrTtoGVdYlvFJdLw==",
 | 
					      "integrity": "sha512-ZN+4sdnLUbo8EVvVc2ao0GFW6oVrQRPn4K2lglySj7APvSrgzxHiNNK99us4WDMi57xxA2yggblIAMNhXOotLQ==",
 | 
				
			||||||
      "dev": true,
 | 
					      "dev": true,
 | 
				
			||||||
 | 
					      "license": "MIT",
 | 
				
			||||||
      "dependencies": {
 | 
					      "dependencies": {
 | 
				
			||||||
        "expect": "^29.0.0",
 | 
					        "expect": "^29.0.0",
 | 
				
			||||||
        "pretty-format": "^29.0.0"
 | 
					        "pretty-format": "^29.0.0"
 | 
				
			||||||
@@ -1827,10 +1821,11 @@
 | 
				
			|||||||
      "dev": true
 | 
					      "dev": true
 | 
				
			||||||
    },
 | 
					    },
 | 
				
			||||||
    "node_modules/@vercel/ncc": {
 | 
					    "node_modules/@vercel/ncc": {
 | 
				
			||||||
      "version": "0.38.1",
 | 
					      "version": "0.38.3",
 | 
				
			||||||
      "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.38.1.tgz",
 | 
					      "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.38.3.tgz",
 | 
				
			||||||
      "integrity": "sha512-IBBb+iI2NLu4VQn3Vwldyi2QwaXt5+hTyh58ggAMoCGE6DJmPvwL3KPBWcJl1m9LYPChBLE980Jw+CS4Wokqxw==",
 | 
					      "integrity": "sha512-rnK6hJBS6mwc+Bkab+PGPs9OiS0i/3kdTO+CkI8V0/VrW3vmz7O2Pxjw/owOlmo6PKEIxRSeZKv/kuL9itnpYA==",
 | 
				
			||||||
      "dev": true,
 | 
					      "dev": true,
 | 
				
			||||||
 | 
					      "license": "MIT",
 | 
				
			||||||
      "bin": {
 | 
					      "bin": {
 | 
				
			||||||
        "ncc": "dist/ncc/cli.js"
 | 
					        "ncc": "dist/ncc/cli.js"
 | 
				
			||||||
      }
 | 
					      }
 | 
				
			||||||
@@ -3218,10 +3213,11 @@
 | 
				
			|||||||
      }
 | 
					      }
 | 
				
			||||||
    },
 | 
					    },
 | 
				
			||||||
    "node_modules/eslint-plugin-jest": {
 | 
					    "node_modules/eslint-plugin-jest": {
 | 
				
			||||||
      "version": "28.8.2",
 | 
					      "version": "28.9.0",
 | 
				
			||||||
      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-28.8.2.tgz",
 | 
					      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-28.9.0.tgz",
 | 
				
			||||||
      "integrity": "sha512-mC3OyklHmS5i7wYU1rGId9EnxRI8TVlnFG56AE+8U9iRy6zwaNygZR+DsdZuCL0gRG0wVeyzq+uWcPt6yJrrMA==",
 | 
					      "integrity": "sha512-rLu1s1Wf96TgUUxSw6loVIkNtUjq1Re7A9QdCCHSohnvXEBAjuL420h0T/fMmkQlNsQP2GhQzEUpYHPfxBkvYQ==",
 | 
				
			||||||
      "dev": true,
 | 
					      "dev": true,
 | 
				
			||||||
 | 
					      "license": "MIT",
 | 
				
			||||||
      "dependencies": {
 | 
					      "dependencies": {
 | 
				
			||||||
        "@typescript-eslint/utils": "^6.0.0 || ^7.0.0 || ^8.0.0"
 | 
					        "@typescript-eslint/utils": "^6.0.0 || ^7.0.0 || ^8.0.0"
 | 
				
			||||||
      },
 | 
					      },
 | 
				
			||||||
@@ -5978,10 +5974,11 @@
 | 
				
			|||||||
      }
 | 
					      }
 | 
				
			||||||
    },
 | 
					    },
 | 
				
			||||||
    "node_modules/prettier": {
 | 
					    "node_modules/prettier": {
 | 
				
			||||||
      "version": "3.3.3",
 | 
					      "version": "3.4.1",
 | 
				
			||||||
      "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz",
 | 
					      "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.4.1.tgz",
 | 
				
			||||||
      "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==",
 | 
					      "integrity": "sha512-G+YdqtITVZmOJje6QkXQWzl3fSfMxFwm1tjTyo9exhkmWSqC4Yhd1+lug++IlR2mvRVAxEDDWYkQdeSztajqgg==",
 | 
				
			||||||
      "dev": true,
 | 
					      "dev": true,
 | 
				
			||||||
 | 
					      "license": "MIT",
 | 
				
			||||||
      "bin": {
 | 
					      "bin": {
 | 
				
			||||||
        "prettier": "bin/prettier.cjs"
 | 
					        "prettier": "bin/prettier.cjs"
 | 
				
			||||||
      },
 | 
					      },
 | 
				
			||||||
@@ -6902,10 +6899,11 @@
 | 
				
			|||||||
      }
 | 
					      }
 | 
				
			||||||
    },
 | 
					    },
 | 
				
			||||||
    "node_modules/typescript": {
 | 
					    "node_modules/typescript": {
 | 
				
			||||||
      "version": "5.5.4",
 | 
					      "version": "5.7.2",
 | 
				
			||||||
      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.4.tgz",
 | 
					      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.7.2.tgz",
 | 
				
			||||||
      "integrity": "sha512-Mtq29sKDAEYP7aljRgtPOpTvOfbwRWlS6dPRzwjdE+C0R4brX/GUyhHSecbHMFLNBLcJIPt9nl9yG5TZ1weH+Q==",
 | 
					      "integrity": "sha512-i5t66RHxDvVN40HfDd1PsEThGNnlMCMT3jMUuoh9/0TaqWevNontacunWyN02LA9/fIbEWlcHZcgTKb9QoaLfg==",
 | 
				
			||||||
      "dev": true,
 | 
					      "dev": true,
 | 
				
			||||||
 | 
					      "license": "Apache-2.0",
 | 
				
			||||||
      "bin": {
 | 
					      "bin": {
 | 
				
			||||||
        "tsc": "bin/tsc",
 | 
					        "tsc": "bin/tsc",
 | 
				
			||||||
        "tsserver": "bin/tsserver"
 | 
					        "tsserver": "bin/tsserver"
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										12
									
								
								package.json
									
									
									
									
									
								
							
							
						
						
									
										12
									
								
								package.json
									
									
									
									
									
								
							@@ -28,7 +28,7 @@
 | 
				
			|||||||
  },
 | 
					  },
 | 
				
			||||||
  "homepage": "https://github.com/actions/checkout#readme",
 | 
					  "homepage": "https://github.com/actions/checkout#readme",
 | 
				
			||||||
  "dependencies": {
 | 
					  "dependencies": {
 | 
				
			||||||
    "@actions/core": "^1.10.1",
 | 
					    "@actions/core": "^1.11.1",
 | 
				
			||||||
    "@actions/exec": "^1.1.1",
 | 
					    "@actions/exec": "^1.1.1",
 | 
				
			||||||
    "@actions/github": "^6.0.0",
 | 
					    "@actions/github": "^6.0.0",
 | 
				
			||||||
    "@actions/io": "^1.1.3",
 | 
					    "@actions/io": "^1.1.3",
 | 
				
			||||||
@@ -36,20 +36,20 @@
 | 
				
			|||||||
    "uuid": "^9.0.1"
 | 
					    "uuid": "^9.0.1"
 | 
				
			||||||
  },
 | 
					  },
 | 
				
			||||||
  "devDependencies": {
 | 
					  "devDependencies": {
 | 
				
			||||||
    "@types/jest": "^29.5.12",
 | 
					    "@types/jest": "^29.5.14",
 | 
				
			||||||
    "@types/node": "^20.12.12",
 | 
					    "@types/node": "^20.12.12",
 | 
				
			||||||
    "@types/uuid": "^9.0.8",
 | 
					    "@types/uuid": "^9.0.8",
 | 
				
			||||||
    "@typescript-eslint/eslint-plugin": "^7.9.0",
 | 
					    "@typescript-eslint/eslint-plugin": "^7.9.0",
 | 
				
			||||||
    "@typescript-eslint/parser": "^7.9.0",
 | 
					    "@typescript-eslint/parser": "^7.9.0",
 | 
				
			||||||
    "@vercel/ncc": "^0.38.1",
 | 
					    "@vercel/ncc": "^0.38.3",
 | 
				
			||||||
    "eslint": "^8.57.0",
 | 
					    "eslint": "^8.57.0",
 | 
				
			||||||
    "eslint-plugin-github": "^4.10.2",
 | 
					    "eslint-plugin-github": "^4.10.2",
 | 
				
			||||||
    "eslint-plugin-jest": "^28.8.2",
 | 
					    "eslint-plugin-jest": "^28.9.0",
 | 
				
			||||||
    "jest": "^29.7.0",
 | 
					    "jest": "^29.7.0",
 | 
				
			||||||
    "jest-circus": "^29.7.0",
 | 
					    "jest-circus": "^29.7.0",
 | 
				
			||||||
    "js-yaml": "^4.1.0",
 | 
					    "js-yaml": "^4.1.0",
 | 
				
			||||||
    "prettier": "^3.3.3",
 | 
					    "prettier": "^3.4.1",
 | 
				
			||||||
    "ts-jest": "^29.2.5",
 | 
					    "ts-jest": "^29.2.5",
 | 
				
			||||||
    "typescript": "^5.5.4"
 | 
					    "typescript": "^5.7.2"
 | 
				
			||||||
  }
 | 
					  }
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user