mirror of
				https://github.com/actions/checkout.git
				synced 2025-10-31 15:47:36 +00:00 
			
		
		
		
	Compare commits
	
		
			1 Commits
		
	
	
		
			v1
			...
			revert-56-
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
|   | d8d55467a3 | 
							
								
								
									
										19
									
								
								.github/workflows/test.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										19
									
								
								.github/workflows/test.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,19 +0,0 @@ | ||||
| name: "test-local" | ||||
| on: | ||||
|   pull_request: | ||||
|   push: | ||||
|     branches: | ||||
|       - master | ||||
|       - 'releases/*' | ||||
|  | ||||
| jobs: | ||||
|   test: | ||||
|     strategy: | ||||
|       matrix: | ||||
|         os: [windows-latest, ubuntu-latest, macOS-latest] | ||||
|     runs-on: ${{ matrix.os }} | ||||
|     steps: | ||||
|     - uses: actions/checkout@master | ||||
|     - uses: ./ | ||||
|       with: | ||||
|         ref: master | ||||
							
								
								
									
										13
									
								
								CHANGELOG.md
									
									
									
									
									
								
							
							
						
						
									
										13
									
								
								CHANGELOG.md
									
									
									
									
									
								
							| @@ -1,13 +0,0 @@ | ||||
| # Changelog | ||||
|  | ||||
| ## Unreleased Changes | ||||
| - N/A | ||||
|  | ||||
| ## v1.2.0 | ||||
| - Reverted the breaking behavior change in v1.1.0 that broke custom authentication flows | ||||
|  | ||||
| ## v1.1.0 (Not reccomended for use, this functionality will be ported to the 2.0 update) | ||||
| - Persist `with.token` or `${{ github.token }}` into checkout repository's git config as `http.https://github.com/.extraheader=AUTHORIZATION: basic ***` to better support scripting git | ||||
|  | ||||
| ## v1.0.0 | ||||
| - Initial Release of the checkout action | ||||
							
								
								
									
										37
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										37
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,8 +1,4 @@ | ||||
| <p align="center"> | ||||
|   <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 | ||||
| # checkout | ||||
|  | ||||
| This action checks out your repository to `$GITHUB_WORKSPACE`, so that your workflow can access the contents of your repository. | ||||
|  | ||||
| @@ -17,44 +13,23 @@ Basic: | ||||
|  | ||||
| ```yaml | ||||
| steps: | ||||
| - uses: actions/checkout@v1 | ||||
| - uses: actions/setup-node@v1 | ||||
| - uses: actions/checkout@master | ||||
| - uses: actions/setup-node@master | ||||
|   with: | ||||
|     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, a different repository or use different token to checkout, specify that using `with.ref`, `with.repository` and `with.token`. | ||||
| 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`: | ||||
|  | ||||
| ## Checkout different branch from the workflow repository | ||||
| ```yaml | ||||
| - uses: actions/checkout@v1 | ||||
| - uses: actions/checkout@master | ||||
|   with: | ||||
|     ref: some-branch | ||||
| ``` | ||||
|  | ||||
| ## Checkout different private repository | ||||
| ```yaml | ||||
| - uses: actions/checkout@v1 | ||||
|   with: | ||||
|     repository: myAccount/myRepository | ||||
|     ref: refs/heads/master | ||||
|     token: ${{ secrets.GitHub_PAT }} # `GitHub_PAT` is a secret contains your PAT. | ||||
| ``` | ||||
| > - `${{ github.token }}` is scoped to the current repository, so if you want to checkout another repository that is private you will need to provide your own [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | ||||
|  | ||||
| ## Checkout private submodules | ||||
| ```yaml | ||||
| - uses: actions/checkout@v1 | ||||
|   with: | ||||
|     submodules: true # 'recursive' 'true' or 'false' | ||||
|     token: ${{ secrets.GitHub_PAT }} # `GitHub_PAT` is a secret contains your PAT. | ||||
| ``` | ||||
| > - Private submodules must be configured via `https` not `ssh`. | ||||
| > - `${{ github.token }}` only has permission to the workflow triggering repository. If the repository contains any submodules that come from private repositories, you will need to add your [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) as secret and use the secret in `with.token` to make the `checkout` action work. | ||||
|  | ||||
| For more details, see [Contexts and expression syntax for GitHub Actions](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions) and [Creating and using encrypted secrets](https://help.github.com/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) | ||||
| 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 | ||||
|  | ||||
|   | ||||
		Reference in New Issue
	
	Block a user