mirror of
				https://github.com/actions/checkout.git
				synced 2025-10-31 18:18:37 +08:00 
			
		
		
		
	Merge f005947568 into ac59398561
				
					
				
			This commit is contained in:
		
						commit
						a985cf984b
					
				
							
								
								
									
										27
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										27
									
								
								README.md
									
									
									
									
									
								
							|  | @ -6,7 +6,7 @@ This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workfl | |||
| 
 | ||||
| Only a single commit is fetched by default, for the ref/SHA that triggered the workflow. Set `fetch-depth: 0` to fetch all history for all branches and tags. Refer [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn which commit `$GITHUB_SHA` points to for different events. | ||||
| 
 | ||||
| The auth token is persisted in the local git config. This enables your scripts to run authenticated git commands. The token is removed during post-job cleanup. Set `persist-credentials: false` to opt-out. | ||||
| The auth token can be persisted in the local git config. This enables your scripts to run authenticated git commands. The token is removed during post-job cleanup. Set `persist-credentials: true` to opt-in. | ||||
| 
 | ||||
| When Git 2.18 or higher is not in your PATH, falls back to the REST API to download the files. | ||||
| 
 | ||||
|  | @ -64,7 +64,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl | |||
|     ssh-strict: '' | ||||
| 
 | ||||
|     # Whether to configure the token or SSH key with the local git config | ||||
|     # Default: true | ||||
|     # Default: false | ||||
|     persist-credentials: '' | ||||
| 
 | ||||
|     # Relative path under $GITHUB_WORKSPACE to place the repository | ||||
|  | @ -106,15 +106,20 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl | |||
| 
 | ||||
| # Scenarios | ||||
| 
 | ||||
| - [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) | ||||
| - [Checkout V3](#checkout-v3) | ||||
| - [What's new](#whats-new) | ||||
| - [Usage](#usage) | ||||
| - [Scenarios](#scenarios) | ||||
|   - [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) | ||||
| - [License](#license) | ||||
| 
 | ||||
| ## Fetch all history for all tags and branches | ||||
| 
 | ||||
|  |  | |||
|  | @ -47,7 +47,7 @@ inputs: | |||
|     default: true | ||||
|   persist-credentials: | ||||
|     description: 'Whether to configure the token or SSH key with the local git config' | ||||
|     default: true | ||||
|     default: false | ||||
|   path: | ||||
|     description: 'Relative path under $GITHUB_WORKSPACE to place the repository' | ||||
|   clean: | ||||
|  |  | |||
		Loading…
	
		Reference in New Issue
	
	Block a user
	 sebbASF
						sebbASF