mirror of
				https://github.com/actions/checkout.git
				synced 2025-10-26 07:38:22 +08:00 
			
		
		
		
	Compare commits
	
		
			11 Commits
		
	
	
		
			Update-des
			...
			revert-56-
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
|   | d8d55467a3 | ||
|   | 0b496e91ec | ||
|   | f6ce2afa70 | ||
|   | 94d077c249 | ||
|   | 0963d3b35f | ||
|   | a14471d838 | ||
|   | 7f0669ca1f | ||
|   | cacfc4155d | ||
|   | 6e6328ef28 | ||
|   | 53bed0742e | ||
|   | b4b537b06a | 
							
								
								
									
										18
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										18
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,22 +1,36 @@ | ||||
| # checkout | ||||
|  | ||||
| This action checks out your repository so that your workflow operates from the root of the repository | ||||
| This action checks out your repository to `$GITHUB_WORKSPACE`, so that your workflow can access the contents of your repository. | ||||
|  | ||||
| By default, this is equivalent to running `git fetch` and `git checkout $GITHUB_SHA`, so that you'll always have your repo contents at the version that triggered the workflow. | ||||
| See [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn what `$GITHUB_SHA` is for different kinds of events. | ||||
|  | ||||
| # Usage | ||||
|  | ||||
| See [action.yml](action.yml) | ||||
|  | ||||
| Basic: | ||||
|  | ||||
| ```yaml | ||||
| steps: | ||||
| - uses: actions/checkout@master | ||||
| - uses: actions/setup-node@master | ||||
|   with: | ||||
|     version: 10.x  | ||||
|     node-version: 10.x  | ||||
| - run: npm install | ||||
| - run: npm test | ||||
| ``` | ||||
|  | ||||
| By default, the branch or tag ref that triggered the workflow will be checked out. If you wish to check out a different branch, specify that using `with.ref`: | ||||
|  | ||||
| ```yaml | ||||
| - uses: actions/checkout@master | ||||
|   with: | ||||
|     ref: some-branch | ||||
| ``` | ||||
|  | ||||
| For more details, see [Contexts and expression syntax for GitHub Actions](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions) | ||||
|  | ||||
| # License | ||||
|  | ||||
| The scripts and documentation in this project are released under the [MIT License](LICENSE) | ||||
|   | ||||
| @@ -1,5 +1,5 @@ | ||||
| name: 'Checkout' | ||||
| description: 'Get sources from a GitHub repository.' | ||||
| description: 'Checkout a Git repository.' | ||||
| inputs:  | ||||
|   repository: | ||||
|     description: 'Repository name' | ||||
| @@ -11,7 +11,7 @@ inputs: | ||||
|     description: 'If true, execute `execute git clean -ffdx && git reset --hard HEAD` before fetching' | ||||
|     default: true | ||||
|   submodules: | ||||
|     description: 'Directory containing files to upload' | ||||
|     description: 'Whether to include submodules: false to exclude submodules, true to include only one level of submodules, or recursive to recursively clone submodules; defaults to false' | ||||
|   lfs: | ||||
|     description: 'Whether to download Git-LFS files; defaults to false' | ||||
|   fetch-depth: | ||||
| @@ -19,4 +19,5 @@ inputs: | ||||
|   path: | ||||
|     description: 'Optional path to check out source code'   | ||||
| runs: | ||||
|   # Plugins live on the runner and are only available to a certain set of first party actions. | ||||
|   plugin: 'checkout' | ||||
|   | ||||
		Reference in New Issue
	
	Block a user