mirror of
				https://github.com/actions/checkout.git
				synced 2025-10-31 23:53:36 +00:00 
			
		
		
		
	update readme
This commit is contained in:
		
							parent
							
								
									e347bba93b
								
							
						
					
					
						commit
						0f394b5ea0
					
				
							
								
								
									
										20
									
								
								CHANGELOG.md
									
									
									
									
									
								
							
							
						
						
									
										20
									
								
								CHANGELOG.md
									
									
									
									
									
								
							| @ -1,20 +1,20 @@ | ||||
| # Changelog | ||||
| 
 | ||||
| ## v2 (preview) | ||||
| ## v2 (beta) | ||||
| 
 | ||||
| - Improved fetch performance | ||||
|   - The default behavior now fetches only the SHA being checked-out. | ||||
|   - The default behavior now fetches only the SHA being checked-out | ||||
| - Script authenticated git commands | ||||
|   - Persists `with.token` in the local git config. | ||||
|   - Enables your scripts to run authenticated git commands. | ||||
|   - Post-job cleanup removes the token. | ||||
|   - Coming soon: Opt out by setting `with.persist-credentials` to `false`. | ||||
|   - Persists `with.token` in the local git config | ||||
|   - Enables your scripts to run authenticated git commands | ||||
|   - Post-job cleanup removes the token | ||||
|   - Coming soon: Opt out by setting `with.persist-credentials` to `false` | ||||
| - Creates a local branch | ||||
|   - No longer detached HEAD when checking out a branch. | ||||
|   - A local branch is created with the corresponding upstream branch set. | ||||
|   - No longer detached HEAD when checking out a branch | ||||
|   - A local branch is created with the corresponding upstream branch set | ||||
| - Improved layout | ||||
|   - `with.path` is always relative to `github.workspace`. | ||||
|   - Aligns better with container actions, where `github.workspace` gets mapped in. | ||||
|   - `with.path` is always relative to `github.workspace` | ||||
|   - Aligns better with container actions, where `github.workspace` gets mapped in | ||||
| - Removed input `submodules` | ||||
| 
 | ||||
| 
 | ||||
|  | ||||
							
								
								
									
										20
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										20
									
								
								README.md
									
									
									
									
									
								
							| @ -2,7 +2,7 @@ | ||||
|   <a href="https://github.com/actions/checkout"><img alt="GitHub Actions status" src="https://github.com/actions/checkout/workflows/test-local/badge.svg"></a> | ||||
| </p> | ||||
| 
 | ||||
| # Checkout V2 (preview) | ||||
| # Checkout V2 (beta) | ||||
| 
 | ||||
| This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it. | ||||
| 
 | ||||
| @ -10,13 +10,29 @@ By default, the repository that triggered the workflow is checked-out, for the r | ||||
| 
 | ||||
| Refer [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn which commit `$GITHUB_SHA` points to for different events. | ||||
| 
 | ||||
| Changes in V2: | ||||
| - Improved fetch performance | ||||
|   - The default behavior now fetches only the SHA being checked-out | ||||
| - Script authenticated git commands | ||||
|   - Persists `with.token` in the local git config | ||||
|   - Enables your scripts to run authenticated git commands | ||||
|   - Post-job cleanup removes the token | ||||
|   - Coming soon: Opt out by setting `with.persist-credentials` to `false` | ||||
| - Creates a local branch | ||||
|   - No longer detached HEAD when checking out a branch | ||||
|   - A local branch is created with the corresponding upstream branch set | ||||
| - Improved layout | ||||
|   - `with.path` is always relative to `github.workspace` | ||||
|   - Aligns better with container actions, where `github.workspace` gets mapped in | ||||
| - Removed input `submodules` | ||||
| 
 | ||||
| Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous versions. | ||||
| 
 | ||||
| # Usage | ||||
| 
 | ||||
| <!-- start usage --> | ||||
| ```yaml | ||||
| - uses: actions/checkout@preview | ||||
| - uses: actions/checkout@v2-beta | ||||
|   with: | ||||
|     # Repository name | ||||
|     # Default: ${{ github.repository }} | ||||
|  | ||||
							
								
								
									
										720
									
								
								dist/index.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										720
									
								
								dist/index.js
									
									
									
									
										vendored
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							| @ -2,7 +2,7 @@ | ||||
|   "name": "checkout", | ||||
|   "version": "2.0.0", | ||||
|   "description": "checkout action", | ||||
|   "main": "lib/main.js", | ||||
|   "main": "dist/index.js", | ||||
|   "scripts": { | ||||
|     "build": "tsc", | ||||
|     "format": "prettier --write **/*.ts", | ||||
|  | ||||
| @ -96,7 +96,7 @@ function updateUsage( | ||||
| } | ||||
| 
 | ||||
| updateUsage( | ||||
|   'actions/checkout@preview', | ||||
|   'actions/checkout@v2-beta', | ||||
|   path.join(__dirname, '..', '..', 'action.yml'), | ||||
|   path.join(__dirname, '..', '..', 'README.md') | ||||
| ) | ||||
|  | ||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user