mirror of
				https://github.com/actions/checkout.git
				synced 2025-11-04 05:58:40 +08:00 
			
		
		
		
	docs: update README.md (#1971)
Add a scenario where it is necessary to push a commit to a pull request.
This commit is contained in:
		
							parent
							
								
									11bd71901b
								
							
						
					
					
						commit
						3b9b8c884f
					
				
							
								
								
									
										26
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										26
									
								
								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
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -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)
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue
	
	Block a user