mirror of
				https://github.com/actions/setup-go.git
				synced 2025-10-29 22:30:31 +00:00 
			
		
		
		
	Compare commits
	
		
			60 Commits
		
	
	
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
|   | fcdc43634a | ||
|   | 265edc1beb | ||
|   | 193b404f8a | ||
|   | 56a61c9834 | ||
|   | b46db954a1 | ||
|   | 3332358454 | ||
|   | 46eabca1ab | ||
|   | 07948221be | ||
|   | ad70bef2ef | ||
|   | 4a4352b330 | ||
|   | 115d6e6004 | ||
|   | bf7ccf173e | ||
|   | dcb4ec94ce | ||
|   | 341b20ac36 | ||
|   | a5865a93f2 | ||
|   | 13df686579 | ||
|   | 8e9a229830 | ||
|   | 0b4fbc55f6 | ||
|   | acdbc5377c | ||
|   | 3e6475c089 | ||
|   | 65771601ff | ||
| ![dependabot[bot]](/assets/img/avatar_default.png)  | fcc0174ef2 | ||
|   | 75726802f3 | ||
|   | 0c03929337 | ||
|   | 229eefa42b | ||
|   | 802876f7c7 | ||
|   | 2a34c33bd7 | ||
|   | 83124a14b6 | ||
|   | 9a1626044c | ||
|   | 24c791c06c | ||
|   | ec07be593a | ||
|   | f6164bd8c8 | ||
|   | 2bb2aab2fd | ||
|   | edcbc0c2cd | ||
|   | fb9a043dd8 | ||
| ![dependabot[bot]](/assets/img/avatar_default.png)  | 5b0ae0e97d | ||
|   | bfdd3570ce | ||
|   | 44e221478f | ||
|   | 424fc82d43 | ||
|   | 82388ea9d4 | ||
|   | fdeec47002 | ||
|   | 3e9d5483e6 | ||
|   | 02f7ea9f09 | ||
|   | 5805cf725b | ||
|   | 35030c1fd2 | ||
|   | 59d644db2a | ||
|   | 76929df236 | ||
|   | b06835a88c | ||
|   | b8a24202e2 | ||
|   | e234d99c78 | ||
|   | 0ea1f64ec9 | ||
|   | 331ce1d993 | ||
|   | 1087a81afd | ||
|   | ecd878f81d | ||
|   | eca066937b | ||
|   | e816064dae | ||
|   | bba6fe1d58 | ||
|   | 3b4dc6cbed | ||
|   | afe68ffd57 | ||
|   | 6eb700292f | 
							
								
								
									
										1
									
								
								.gitattributes
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.gitattributes
									
									
									
									
										vendored
									
									
								
							| @@ -1 +1,2 @@ | ||||
| * text=auto | ||||
| .licenses/** -diff linguist-generated=true | ||||
							
								
								
									
										38
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										38
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,38 @@ | ||||
| --- | ||||
| name: Bug report | ||||
| about: Create a bug report | ||||
| title: '' | ||||
| labels: bug, needs triage | ||||
| assignees: '' | ||||
|  | ||||
| --- | ||||
|  | ||||
| <!--- Please direct any generic questions related to actions to our support community forum at https://github.community/c/code-to-cloud/github-actions/41 ---> | ||||
| <!--- Before opening up a new bug report, please make sure to check for similar existing issues --> | ||||
|  | ||||
| **Description:** | ||||
| A clear and concise description of what the bug is. | ||||
|  | ||||
| **Action version:** | ||||
| Specify the action version | ||||
|  | ||||
| **Platform:** | ||||
| - [ ] Ubuntu | ||||
| - [ ] macOS | ||||
| - [ ] Windows | ||||
|  | ||||
| **Runner type:** | ||||
| - [ ] Hosted | ||||
| - [ ] Self-hosted | ||||
|  | ||||
| **Tools version:** | ||||
| <!--- Please specify go version --> | ||||
|  | ||||
| **Repro steps:**   | ||||
| A description with steps to reproduce the issue. If your have a public example or repo to share, please provide the link. | ||||
|  | ||||
| **Expected behavior:** | ||||
| A description of what you expected to happen. | ||||
|  | ||||
| **Actual behavior:** | ||||
| A description of what is actually happening. | ||||
							
								
								
									
										1
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1 @@ | ||||
| blank_issues_enabled: false | ||||
							
								
								
									
										18
									
								
								.github/ISSUE_TEMPLATE/feature_request.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								.github/ISSUE_TEMPLATE/feature_request.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,18 @@ | ||||
| --- | ||||
| name: Feature request | ||||
| about: Suggest an idea for this project | ||||
| title: '' | ||||
| labels: feature request, needs triage | ||||
| assignees: '' | ||||
| --- | ||||
| <!--- Please direct any generic questions related to actions to our support community forum at https://github.community/c/code-to-cloud/github-actions/41 ---> | ||||
| <!--- Before opening up a new feature request, please make sure to check for similar existing issues and pull requests --> | ||||
|  | ||||
| **Description:** | ||||
| Describe your proposal. | ||||
|  | ||||
| **Justification:** | ||||
| Justification or a use case for your proposal. | ||||
|  | ||||
| **Are you willing to submit a PR?** | ||||
| <!--- We accept contributions! --> | ||||
							
								
								
									
										9
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										9
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,9 @@ | ||||
| **Description:** | ||||
| Describe your changes. | ||||
|  | ||||
| **Related issue:** | ||||
| Add link to the related issue. | ||||
|  | ||||
| **Check list:** | ||||
| - [ ] Mark if documentation changes are required. | ||||
| - [ ] Mark if tests were added or updated to cover the changes. | ||||
							
								
								
									
										51
									
								
								.github/workflows/check-dist.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										51
									
								
								.github/workflows/check-dist.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,51 @@ | ||||
| # `dist/index.js` is a special file in Actions. | ||||
| # When you reference an action with `uses:` in a workflow, | ||||
| # `index.js` is the code that will run. | ||||
| # For our project, we generate this file through a build process from other source files. | ||||
| # We need to make sure the checked-in `index.js` actually matches what we expect it to be. | ||||
| name: Check dist/ | ||||
|  | ||||
| on: | ||||
|   push: | ||||
|     branches: | ||||
|       - main | ||||
|     paths-ignore: | ||||
|       - '**.md' | ||||
|   pull_request: | ||||
|     paths-ignore: | ||||
|       - '**.md' | ||||
|   workflow_dispatch: | ||||
|  | ||||
| jobs: | ||||
|   check-dist: | ||||
|     runs-on: ubuntu-latest | ||||
|  | ||||
|     steps: | ||||
|       - uses: actions/checkout@v3 | ||||
|  | ||||
|       - name: Set Node.js 16.x | ||||
|         uses: actions/setup-node@v3 | ||||
|         with: | ||||
|           node-version: 16.x | ||||
|  | ||||
|       - name: Install dependencies | ||||
|         run: npm ci | ||||
|  | ||||
|       - name: Rebuild the dist/ directory | ||||
|         run: npm run build | ||||
|  | ||||
|       - name: Compare the expected and actual dist/ directories | ||||
|         run: | | ||||
|           if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then | ||||
|             echo "Detected uncommitted changes after build.  See status below:" | ||||
|             git diff | ||||
|             exit 1 | ||||
|           fi | ||||
|         id: diff | ||||
|  | ||||
|       # If index.js was different than expected, upload the expected version as an artifact | ||||
|       - uses: actions/upload-artifact@v3 | ||||
|         if: ${{ failure() && steps.diff.conclusion == 'failure' }} | ||||
|         with: | ||||
|           name: dist | ||||
|           path: dist/ | ||||
							
								
								
									
										18
									
								
								.github/workflows/licensed.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										18
									
								
								.github/workflows/licensed.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,20 +1,28 @@ | ||||
| name: Licensed | ||||
|  | ||||
| on: | ||||
|   push: {branches: main} | ||||
|   pull_request: {branches: main} | ||||
|   push: | ||||
|     branches: | ||||
|       - main | ||||
|   pull_request: | ||||
|     branches: | ||||
|       - main | ||||
|  | ||||
| jobs: | ||||
|   test: | ||||
|     runs-on: ubuntu-latest | ||||
|     name: Check licenses | ||||
|     steps: | ||||
|       - uses: actions/checkout@v2 | ||||
|       - uses: actions/checkout@v3 | ||||
|       - name: Set Node.js 16.x | ||||
|         uses: actions/setup-node@v3 | ||||
|         with: | ||||
|           node-version: 16.x | ||||
|       - run: npm ci | ||||
|       - name: Install licensed | ||||
|         run: | | ||||
|           cd $RUNNER_TEMP | ||||
|           curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/2.12.2/licensed-2.12.2-linux-x64.tar.gz | ||||
|           curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/3.4.4/licensed-3.4.4-linux-x64.tar.gz | ||||
|           sudo tar -xzf licensed.tar.gz | ||||
|           sudo mv licensed /usr/local/bin/licensed | ||||
|       - run: licensed status | ||||
|       - run: licensed status | ||||
|   | ||||
							
								
								
									
										27
									
								
								.github/workflows/release-new-action-version.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								.github/workflows/release-new-action-version.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,27 @@ | ||||
| name: Release new action version | ||||
| on: | ||||
|   release: | ||||
|     types: [released] | ||||
|   workflow_dispatch: | ||||
|     inputs: | ||||
|       TAG_NAME: | ||||
|         description: 'Tag name that the major tag will point to' | ||||
|         required: true | ||||
|  | ||||
| env: | ||||
|   TAG_NAME: ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }} | ||||
| permissions: | ||||
|   contents: write | ||||
|  | ||||
| jobs: | ||||
|   update_tag: | ||||
|     name: Update the major tag to include the ${{ github.event.inputs.TAG_NAME || github.event.release.tag_name }} changes | ||||
|     environment: | ||||
|       name: releaseNewActionVersion | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - name: Update the ${{ env.TAG_NAME }} tag | ||||
|         uses: actions/publish-action@v0.1.0 | ||||
|         with: | ||||
|           source-tag: ${{ env.TAG_NAME }} | ||||
|           slack-webhook: ${{ secrets.SLACK_WEBHOOK }} | ||||
							
								
								
									
										63
									
								
								.github/workflows/versions.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										63
									
								
								.github/workflows/versions.yml
									
									
									
									
										vendored
									
									
								
							| @@ -22,7 +22,7 @@ jobs: | ||||
|         go: [1.12, 1.13, 1.14] | ||||
|     steps: | ||||
|       - name: Checkout | ||||
|         uses: actions/checkout@v2 | ||||
|         uses: actions/checkout@v3 | ||||
|  | ||||
|       - name: setup-go ${{ matrix.go }} | ||||
|         uses: ./ | ||||
| @@ -33,6 +33,39 @@ jobs: | ||||
|         run: __tests__/verify-go.sh ${{ matrix.go }} | ||||
|         shell: bash | ||||
|  | ||||
|   check-latest: | ||||
|     runs-on: ${{ matrix.os }} | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         os: [ubuntu-latest, windows-latest, macos-latest] | ||||
|         go-version: [1.16, 1.17] | ||||
|     steps: | ||||
|       - uses: actions/checkout@v3 | ||||
|       - name: Setup Go and check latest | ||||
|         uses: ./ | ||||
|         with: | ||||
|           go-version: ${{ matrix.go-version }} | ||||
|           check-latest: true | ||||
|       - name: Verify Go | ||||
|         run: go version | ||||
|  | ||||
|   go-version-file: | ||||
|     runs-on: ${{ matrix.os }} | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         os: [ubuntu-latest, windows-latest, macos-latest] | ||||
|     steps: | ||||
|       - uses: actions/checkout@v3 | ||||
|       - name: Setup Go and check latest | ||||
|         uses: ./ | ||||
|         with: | ||||
|           go-version-file: __tests__/data/go.mod | ||||
|       - name: verify go | ||||
|         run: __tests__/verify-go.sh 1.14 | ||||
|         shell: bash | ||||
|  | ||||
|   setup-versions-from-manifest: | ||||
|     name: Setup ${{ matrix.go }} ${{ matrix.os }} | ||||
|     runs-on: ${{ matrix.os }} | ||||
| @@ -43,13 +76,13 @@ jobs: | ||||
|         go: [1.12.16, 1.13.11, 1.14.3] | ||||
|     steps: | ||||
|       - name: Checkout | ||||
|         uses: actions/checkout@v2 | ||||
|        | ||||
|         uses: actions/checkout@v3 | ||||
|  | ||||
|       - name: setup-go ${{ matrix.go }} | ||||
|         uses: ./ | ||||
|         with: | ||||
|           go-version: ${{ matrix.go }} | ||||
|        | ||||
|  | ||||
|       - name: verify go | ||||
|         run: __tests__/verify-go.sh ${{ matrix.go }} | ||||
|         shell: bash | ||||
| @@ -61,14 +94,16 @@ jobs: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         os: [macos-latest, windows-latest, ubuntu-latest] | ||||
|         go: [1.7, 1.8.6] | ||||
|         go: [1.9, 1.8.6] | ||||
|     steps: | ||||
|     - name: Checkout | ||||
|       uses: actions/checkout@v2 | ||||
|     - name: setup-go ${{ matrix.go }} | ||||
|       uses: ./ | ||||
|       with: | ||||
|         go-version: ${{ matrix.go }} | ||||
|     - name: verify go | ||||
|       run: __tests__/verify-go.sh ${{ matrix.go }} | ||||
|       shell: bash | ||||
|       - name: Checkout | ||||
|         uses: actions/checkout@v3 | ||||
|  | ||||
|       - name: setup-go ${{ matrix.go }} | ||||
|         uses: ./ | ||||
|         with: | ||||
|           go-version: ${{ matrix.go }} | ||||
|  | ||||
|       - name: verify go | ||||
|         run: __tests__/verify-go.sh ${{ matrix.go }} | ||||
|         shell: bash | ||||
|   | ||||
							
								
								
									
										31
									
								
								.github/workflows/workflow.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										31
									
								
								.github/workflows/workflow.yml
									
									
									
									
										vendored
									
									
								
							| @@ -16,23 +16,24 @@ jobs: | ||||
|       matrix: | ||||
|         operating-system: [ubuntu-latest, windows-latest] | ||||
|     steps: | ||||
|     - name: Checkout | ||||
|       uses: actions/checkout@v2 | ||||
|       - name: Checkout | ||||
|         uses: actions/checkout@v3 | ||||
|  | ||||
|     - name: Setup node 12 | ||||
|       uses: actions/setup-node@v1 | ||||
|       with: | ||||
|         node-version: 12 | ||||
|       - name: Setup node 16 | ||||
|         uses: actions/setup-node@v3 | ||||
|         with: | ||||
|           node-version: 16 | ||||
|           cache: npm | ||||
|  | ||||
|     - name: npm install | ||||
|       run: npm install | ||||
|       - name: npm ci | ||||
|         run: npm ci | ||||
|  | ||||
|     - name: Lint | ||||
|       run: npm run format-check | ||||
|       - name: Lint | ||||
|         run: npm run format-check | ||||
|  | ||||
|     - name: npm test | ||||
|       run: npm test | ||||
|       - name: npm test | ||||
|         run: npm test | ||||
|  | ||||
|     - name: audit packages | ||||
|       run: npm audit --audit-level=high | ||||
|       if: matrix.operating-system == 'ubuntu-latest' | ||||
|       - name: audit packages | ||||
|         run: npm audit --audit-level=high | ||||
|         if: matrix.operating-system == 'ubuntu-latest' | ||||
|   | ||||
							
								
								
									
										2
									
								
								.licenses/npm/@actions/core.dep.yml
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										2
									
								
								.licenses/npm/@actions/core.dep.yml
									
									
									
										generated
									
									
									
								
							| @@ -1,6 +1,6 @@ | ||||
| --- | ||||
| name: "@actions/core" | ||||
| version: 1.2.6 | ||||
| version: 1.6.0 | ||||
| type: npm | ||||
| summary: Actions core lib | ||||
| homepage: https://github.com/actions/toolkit/tree/main/packages/core | ||||
|   | ||||
							
								
								
									
										32
									
								
								.licenses/npm/@actions/http-client-1.0.11.dep.yml
									
									
									
										generated
									
									
									
										Normal file
									
								
							
							
						
						
									
										32
									
								
								.licenses/npm/@actions/http-client-1.0.11.dep.yml
									
									
									
										generated
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,32 @@ | ||||
| --- | ||||
| name: "@actions/http-client" | ||||
| version: 1.0.11 | ||||
| type: npm | ||||
| summary: Actions Http Client | ||||
| homepage: https://github.com/actions/http-client#readme | ||||
| license: mit | ||||
| licenses: | ||||
| - sources: LICENSE | ||||
|   text: | | ||||
|     Actions Http Client for Node.js | ||||
| 
 | ||||
|     Copyright (c) GitHub, Inc. | ||||
| 
 | ||||
|     All rights reserved. | ||||
| 
 | ||||
|     MIT License | ||||
| 
 | ||||
|     Permission is hereby granted, free of charge, to any person obtaining a copy of this software and | ||||
|     associated documentation files (the "Software"), to deal in the Software without restriction, | ||||
|     including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, | ||||
|     and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, | ||||
|     subject to the following conditions: | ||||
| 
 | ||||
|     The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||||
| 
 | ||||
|     THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT | ||||
|     LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN | ||||
|     NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, | ||||
|     WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE | ||||
|     SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||||
| notices: [] | ||||
							
								
								
									
										1
									
								
								CODEOWNERS
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								CODEOWNERS
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1 @@ | ||||
| * @actions/actions-service | ||||
| @@ -55,7 +55,7 @@ a project may be further defined and clarified by project maintainers. | ||||
| ## Enforcement | ||||
| 
 | ||||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||||
| reported by contacting the project team at opensource@github.com. All | ||||
| reported by contacting the project team at opensource+actions/setup-go@github.com. All | ||||
| complaints will be reviewed and investigated and will result in a response that | ||||
| is deemed necessary and appropriate to the circumstances. The project team is | ||||
| obligated to maintain confidentiality with regard to the reporter of an incident. | ||||
| @@ -73,4 +73,4 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht | ||||
| [homepage]: https://www.contributor-covenant.org | ||||
| 
 | ||||
| For answers to common questions about this code of conduct, see | ||||
| https://www.contributor-covenant.org/faq | ||||
| https://www.contributor-covenant.org/faq | ||||
							
								
								
									
										140
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										140
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,87 +1,151 @@ | ||||
| # setup-go | ||||
|  | ||||
| <p align="left"> | ||||
|   <a href="https://github.com/actions/setup-go/actions"><img alt="GitHub Actions status" src="https://github.com/actions/setup-go/workflows/build-test/badge.svg"></a> | ||||
|  | ||||
|   <a href="https://github.com/actions/setup-go/actions"><img alt="versions status" src="https://github.com/actions/setup-go/workflows/go-versions/badge.svg"></a>   | ||||
| </p> | ||||
| [](https://github.com/actions/setup-go/actions/workflows/workflow.yml) | ||||
| [](https://github.com/actions/setup-go/actions/workflows/versions.yml) | ||||
|  | ||||
| This action sets up a go environment for use in actions by: | ||||
|  | ||||
| - optionally downloading and caching a version of Go by version and adding to PATH | ||||
| - registering problem matchers for error output | ||||
| - Optionally downloading and caching a version of Go by version and adding to `PATH`. | ||||
| - Registering problem matchers for error output. | ||||
|  | ||||
| # V2 | ||||
| # V3 | ||||
|  | ||||
| The V2 offers: | ||||
| - Adds GOBIN to the PATH | ||||
| - Proxy Support | ||||
| - stable input  | ||||
| - Bug Fixes (including issues around version matching and semver) | ||||
| The V3 edition of the action offers: | ||||
|  | ||||
| It will first check the local cache for a version match. If version is not found locally, It will pull it from `main` branch of [go-versions](https://github.com/actions/go-versions/blob/main/versions-manifest.json) repository and on miss or failure, it will fall back to the previous behavior of download directly from [go dist](https://storage.googleapis.com/golang). | ||||
| - Adds `GOBIN` to the `PATH` | ||||
| - Proxy support | ||||
| - Check latest version | ||||
| - Bug fixes (including issues around version matching and semver) | ||||
|  | ||||
| The action will first check the local cache for a version match. If a version is not found locally, it will pull it from the `main` branch of the [go-versions](https://github.com/actions/go-versions/blob/main/versions-manifest.json) repository. On miss or failure, it will fall back to downloading directly from [go dist](https://storage.googleapis.com/golang). To change the default behavior, please use the [check-latest input](#check-latest-version). | ||||
|  | ||||
| **Note:** The `setup-go` action uses executable binaries which are built by Golang side. The action does not build golang from source code. | ||||
|  | ||||
| Matching by [semver spec](https://github.com/npm/node-semver): | ||||
|  | ||||
| Matching by semver spec: | ||||
| ```yaml | ||||
| steps: | ||||
| - uses: actions/checkout@v2 | ||||
| - uses: actions/setup-go@v2 | ||||
|   with: | ||||
|     go-version: '^1.13.1' # The Go version to download (if necessary) and use. | ||||
| - run: go version | ||||
|   - uses: actions/checkout@v3 | ||||
|   - uses: actions/setup-go@v3 | ||||
|     with: | ||||
|       go-version: '^1.13.1' # The Go version to download (if necessary) and use. | ||||
|   - run: go version | ||||
| ``` | ||||
|  | ||||
| ```yaml | ||||
| steps: | ||||
|   - uses: actions/checkout@v3 | ||||
|   - uses: actions/setup-go@v3 | ||||
|     with: | ||||
|       go-version: '>=1.17.0' | ||||
|   - run: go version | ||||
| ``` | ||||
|  | ||||
| Matching an unstable pre-release: | ||||
|  | ||||
| ```yaml | ||||
| steps: | ||||
| - uses: actions/checkout@v2 | ||||
| - uses: actions/setup-go@v2 | ||||
|   with: | ||||
|     stable: 'false' | ||||
|     go-version: '1.14.0-rc1' # The Go version to download (if necessary) and use. | ||||
| - run: go version | ||||
|   - uses: actions/checkout@v3 | ||||
|   - uses: actions/setup-go@v3 | ||||
|     with: | ||||
|       go-version: '1.18.0-rc.1' # The Go version to download (if necessary) and use. | ||||
|   - run: go version | ||||
| ``` | ||||
|  | ||||
| ```yaml | ||||
| steps: | ||||
|   - uses: actions/checkout@v3 | ||||
|   - uses: actions/setup-go@v3 | ||||
|     with: | ||||
|       go-version: '1.16.0-beta.1' # The Go version to download (if necessary) and use. | ||||
|   - run: go version | ||||
| ``` | ||||
|  | ||||
| # Usage | ||||
|  | ||||
| See [action.yml](action.yml) | ||||
|  | ||||
| Basic: | ||||
| ## Basic | ||||
|  | ||||
| ```yaml | ||||
| steps: | ||||
| - uses: actions/checkout@master | ||||
| - uses: actions/setup-go@v1 | ||||
|   with: | ||||
|     go-version: '1.9.3' # The Go version to download (if necessary) and use. | ||||
| - run: go run hello.go | ||||
|   - uses: actions/checkout@v3 | ||||
|   - uses: actions/setup-go@v3 | ||||
|     with: | ||||
|       go-version: '1.16.1' # The Go version to download (if necessary) and use. | ||||
|   - run: go run hello.go | ||||
| ``` | ||||
|  | ||||
| Matrix Testing: | ||||
|  | ||||
| ## Check latest version | ||||
|  | ||||
| The `check-latest` flag defaults to `false`. Use the default or set `check-latest` to `false` if you prefer stability and if you want to ensure a specific Go version is always used. | ||||
|  | ||||
| If `check-latest` is set to `true`, the action first checks if the cached version is the latest one. If the locally cached version is not the most up-to-date, a Go version will then be downloaded. Set `check-latest` to `true` if you want the most up-to-date Go version to always be used. | ||||
|  | ||||
| > Setting `check-latest` to `true` has performance implications as downloading Go versions is slower than using cached versions. | ||||
|  | ||||
| ```yaml | ||||
| steps: | ||||
|   - uses: actions/checkout@v3 | ||||
|   - uses: actions/setup-go@v3 | ||||
|     with: | ||||
|       go-version: '1.14' | ||||
|       check-latest: true | ||||
|   - run: go run hello.go | ||||
| ``` | ||||
| ## Getting go version from the go.mod file | ||||
|  | ||||
| The `go-version-file` input accepts a path to a `go.mod` file containing the version of Go to be used by a project. As the `go.mod` file contains only major and minor (e.g. 1.18) tags, the action will search for the latest available patch version sequentially in the runner's directory with the cached tools, in the [version-manifest.json](https://github.com/actions/go-versions/blob/main/versions-manifest.json) file or at the go servers. | ||||
|  | ||||
| If both the `go-version` and the `go-version-file` inputs are provided then the `go-version` input is used. | ||||
| > The action will search for the `go.mod` file relative to the repository root | ||||
|  | ||||
| ```yaml | ||||
| steps: | ||||
| - uses: actions/checkout@v3 | ||||
| - uses: actions/setup-go@v3 | ||||
|   with: | ||||
|     go-version-file: 'path/to/go.mod' | ||||
| - run: go version | ||||
| ``` | ||||
|  | ||||
| ## Matrix testing | ||||
|  | ||||
| ```yaml | ||||
| jobs: | ||||
|   build: | ||||
|     runs-on: ubuntu-16.04 | ||||
|     runs-on: ubuntu-latest | ||||
|     strategy: | ||||
|       matrix: | ||||
|         go: [ '1.14', '1.13' ] | ||||
|     name: Go ${{ matrix.go }} sample | ||||
|     steps: | ||||
|       - uses: actions/checkout@v2 | ||||
|       - uses: actions/checkout@v3 | ||||
|       - name: Setup go | ||||
|         uses: actions/setup-go@v1 | ||||
|         uses: actions/setup-go@v3 | ||||
|         with: | ||||
|           go-version: ${{ matrix.go }} | ||||
|       - run: go run hello.go | ||||
| ``` | ||||
|  | ||||
| ### Supported version syntax | ||||
|  | ||||
| The `go-version` input supports the following syntax: | ||||
|  | ||||
| - Specific versions: `1.15`, `1.16.1`, `1.17.0-rc.2`, `1.16.0-beta.1` | ||||
| - SemVer's version range syntax: `^1.13.1`, `>=1.18.0-rc.1` | ||||
|  | ||||
| For more information about semantic versioning, please refer to [semver](https://github.com/npm/node-semver) documentation. | ||||
|  | ||||
| # License | ||||
|  | ||||
| The scripts and documentation in this project are released under the [MIT License](LICENSE) | ||||
|  | ||||
| # Contributions | ||||
|  | ||||
| Contributions are welcome!  See [Contributor's Guide](docs/contributors.md) | ||||
| Contributions are welcome! See [Contributor's Guide](docs/contributors.md) | ||||
|  | ||||
| ## Code of Conduct | ||||
|  | ||||
| :wave: Be nice.  See [our code of conduct](CONDUCT) | ||||
| :wave: Be nice. See [our code of conduct](CONDUCT) | ||||
|   | ||||
							
								
								
									
										12
									
								
								__tests__/data/go.mod
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								__tests__/data/go.mod
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,12 @@ | ||||
| module example.com/mymodule | ||||
|  | ||||
| go 1.14 | ||||
|  | ||||
| require ( | ||||
| 	example.com/othermodule v1.2.3 | ||||
| 	example.com/thismodule v1.2.3 | ||||
| 	example.com/thatmodule v1.2.3 | ||||
| ) | ||||
|  | ||||
| replace example.com/thatmodule => ../thatmodule | ||||
| exclude example.com/thismodule v1.3.0 | ||||
| @@ -1,4 +1,29 @@ | ||||
| [ | ||||
|     { | ||||
|       "version": "1.17.6", | ||||
|       "stable": true, | ||||
|       "release_url": "https://github.com/actions/go-versions/releases/tag/1.17.6-1668090892", | ||||
|       "files": [ | ||||
|         { | ||||
|           "filename": "go-1.17.6-darwin-x64.tar.gz", | ||||
|           "arch": "x64", | ||||
|           "platform": "darwin", | ||||
|           "download_url": "https://github.com/actions/go-versions/releases/download/1.17.6-1668090892/go-1.17.6-darwin-x64.tar.gz" | ||||
|         }, | ||||
|         { | ||||
|           "filename": "go-1.17.6-linux-x64.tar.gz", | ||||
|           "arch": "x64", | ||||
|           "platform": "linux", | ||||
|           "download_url": "https://github.com/actions/go-versions/releases/download/1.17.6-1668090892/go-1.17.6-linux-x64.tar.gz" | ||||
|         }, | ||||
|         { | ||||
|           "filename": "go-1.17.6-win32-x64.zip", | ||||
|           "arch": "x64", | ||||
|           "platform": "win32", | ||||
|           "download_url": "https://github.com/actions/go-versions/releases/download/1.17.6-1668090892/go-1.17.6-win32-x64.zip" | ||||
|         } | ||||
|       ] | ||||
|     }, | ||||
|     { | ||||
|       "version": "1.12.17", | ||||
|       "stable": true, | ||||
|   | ||||
| @@ -19,6 +19,8 @@ describe('setup-go', () => { | ||||
|   let os = {} as any; | ||||
|  | ||||
|   let inSpy: jest.SpyInstance; | ||||
|   let getBooleanInputSpy: jest.SpyInstance; | ||||
|   let exportVarSpy: jest.SpyInstance; | ||||
|   let findSpy: jest.SpyInstance; | ||||
|   let cnSpy: jest.SpyInstance; | ||||
|   let logSpy: jest.SpyInstance; | ||||
| @@ -26,25 +28,30 @@ describe('setup-go', () => { | ||||
|   let platSpy: jest.SpyInstance; | ||||
|   let archSpy: jest.SpyInstance; | ||||
|   let dlSpy: jest.SpyInstance; | ||||
|   let exSpy: jest.SpyInstance; | ||||
|   let extractTarSpy: jest.SpyInstance; | ||||
|   let cacheSpy: jest.SpyInstance; | ||||
|   let dbgSpy: jest.SpyInstance; | ||||
|   let whichSpy: jest.SpyInstance; | ||||
|   let existsSpy: jest.SpyInstance; | ||||
|   let readFileSpy: jest.SpyInstance; | ||||
|   let mkdirpSpy: jest.SpyInstance; | ||||
|   let execSpy: jest.SpyInstance; | ||||
|   let getManifestSpy: jest.SpyInstance; | ||||
|  | ||||
|   beforeAll(() => { | ||||
|     process.env['GITHUB_PATH'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out | ||||
|     console.log('::stop-commands::stoptoken'); // Disable executing of runner commands when running tests in actions | ||||
|   }); | ||||
|   beforeAll(async () => { | ||||
|     process.env['GITHUB_ENV'] = ''; // Stub out Environment file functionality so we can verify it writes to standard out (toolkit is backwards compatible) | ||||
|   }, 100000); | ||||
|  | ||||
|   beforeEach(() => { | ||||
|     process.env['GITHUB_PATH'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out | ||||
|  | ||||
|     // @actions/core | ||||
|     inputs = {}; | ||||
|     inSpy = jest.spyOn(core, 'getInput'); | ||||
|     inSpy.mockImplementation(name => inputs[name]); | ||||
|     getBooleanInputSpy = jest.spyOn(core, 'getBooleanInput'); | ||||
|     getBooleanInputSpy.mockImplementation(name => inputs[name]); | ||||
|     exportVarSpy = jest.spyOn(core, 'exportVariable'); | ||||
|  | ||||
|     // node | ||||
|     os = {}; | ||||
| @@ -57,7 +64,7 @@ describe('setup-go', () => { | ||||
|     // @actions/tool-cache | ||||
|     findSpy = jest.spyOn(tc, 'find'); | ||||
|     dlSpy = jest.spyOn(tc, 'downloadTool'); | ||||
|     exSpy = jest.spyOn(tc, 'extractTar'); | ||||
|     extractTarSpy = jest.spyOn(tc, 'extractTar'); | ||||
|     cacheSpy = jest.spyOn(tc, 'cacheDir'); | ||||
|     getSpy = jest.spyOn(im, 'getVersionsDist'); | ||||
|     getManifestSpy = jest.spyOn(tc, 'getManifestFromRepo'); | ||||
| @@ -65,6 +72,7 @@ describe('setup-go', () => { | ||||
|     // io | ||||
|     whichSpy = jest.spyOn(io, 'which'); | ||||
|     existsSpy = jest.spyOn(fs, 'existsSync'); | ||||
|     readFileSpy = jest.spyOn(fs, 'readFileSync'); | ||||
|     mkdirpSpy = jest.spyOn(io, 'mkdirP'); | ||||
|  | ||||
|     // gets | ||||
| @@ -81,7 +89,7 @@ describe('setup-go', () => { | ||||
|     }); | ||||
|     logSpy.mockImplementation(line => { | ||||
|       // uncomment to debug | ||||
|       // process.stderr.write('log:' + line + '\n'); | ||||
|       process.stderr.write('log:' + line + '\n'); | ||||
|     }); | ||||
|     dbgSpy.mockImplementation(msg => { | ||||
|       // uncomment to see debug output | ||||
| @@ -96,9 +104,14 @@ describe('setup-go', () => { | ||||
|   }); | ||||
|  | ||||
|   afterAll(async () => { | ||||
|     console.log('::stoptoken::'); // Re-enable executing of runner commands when running tests in actions | ||||
|     jest.restoreAllMocks(); | ||||
|   }, 100000); | ||||
|  | ||||
|   it('can extract the major.minor.patch version from a given Go version string', async () => { | ||||
|     const goVersionOutput = 'go version go1.16.6 darwin/amd64'; | ||||
|     expect(main.parseGoVersion(goVersionOutput)).toBe('1.16.6'); | ||||
|   }); | ||||
|  | ||||
|   it('can find 1.9.7 from manifest on osx', async () => { | ||||
|     os.platform = 'darwin'; | ||||
|     os.arch = 'x64'; | ||||
| @@ -143,7 +156,7 @@ describe('setup-go', () => { | ||||
|     os.arch = 'x64'; | ||||
|  | ||||
|     // spec: 1.13.0 => 1.13 | ||||
|     let match: im.IGoVersion | undefined = await im.findMatch('1.13.0', true); | ||||
|     let match: im.IGoVersion | undefined = await im.findMatch('1.13.0'); | ||||
|     expect(match).toBeDefined(); | ||||
|     let version: string = match ? match.version : ''; | ||||
|     expect(version).toBe('go1.13'); | ||||
| @@ -156,7 +169,7 @@ describe('setup-go', () => { | ||||
|     os.arch = 'x64'; | ||||
|  | ||||
|     // spec: 1.13 => 1.13.7 (latest) | ||||
|     let match: im.IGoVersion | undefined = await im.findMatch('1.13', true); | ||||
|     let match: im.IGoVersion | undefined = await im.findMatch('1.13'); | ||||
|     expect(match).toBeDefined(); | ||||
|     let version: string = match ? match.version : ''; | ||||
|     expect(version).toBe('go1.13.7'); | ||||
| @@ -169,7 +182,7 @@ describe('setup-go', () => { | ||||
|     os.arch = 'x64'; | ||||
|  | ||||
|     // spec: ^1.13.6 => 1.13.7 | ||||
|     let match: im.IGoVersion | undefined = await im.findMatch('^1.13.6', true); | ||||
|     let match: im.IGoVersion | undefined = await im.findMatch('^1.13.6'); | ||||
|     expect(match).toBeDefined(); | ||||
|     let version: string = match ? match.version : ''; | ||||
|     expect(version).toBe('go1.13.7'); | ||||
| @@ -182,7 +195,7 @@ describe('setup-go', () => { | ||||
|     os.arch = 'x32'; | ||||
|  | ||||
|     // spec: 1 => 1.13.7 (latest) | ||||
|     let match: im.IGoVersion | undefined = await im.findMatch('1', true); | ||||
|     let match: im.IGoVersion | undefined = await im.findMatch('1'); | ||||
|     expect(match).toBeDefined(); | ||||
|     let version: string = match ? match.version : ''; | ||||
|     expect(version).toBe('go1.13.7'); | ||||
| @@ -195,10 +208,7 @@ describe('setup-go', () => { | ||||
|     os.arch = 'x64'; | ||||
|  | ||||
|     // spec: 1.14, stable=false => go1.14rc1 | ||||
|     let match: im.IGoVersion | undefined = await im.findMatch( | ||||
|       '1.14.0-rc1', | ||||
|       false | ||||
|     ); | ||||
|     let match: im.IGoVersion | undefined = await im.findMatch('1.14.0-rc.1'); | ||||
|     expect(match).toBeDefined(); | ||||
|     let version: string = match ? match.version : ''; | ||||
|     expect(version).toBe('go1.14rc1'); | ||||
| @@ -214,7 +224,7 @@ describe('setup-go', () => { | ||||
|     findSpy.mockImplementation(() => toolPath); | ||||
|     await main.run(); | ||||
|  | ||||
|     expect(logSpy).toHaveBeenCalledWith(`Setup go stable version spec 1.13.0`); | ||||
|     expect(logSpy).toHaveBeenCalledWith(`Setup go version spec 1.13.0`); | ||||
|   }); | ||||
|  | ||||
|   it('evaluates to stable with no input', async () => { | ||||
| @@ -226,7 +236,41 @@ describe('setup-go', () => { | ||||
|     findSpy.mockImplementation(() => toolPath); | ||||
|     await main.run(); | ||||
|  | ||||
|     expect(logSpy).toHaveBeenCalledWith(`Setup go stable version spec 1.13.0`); | ||||
|     expect(logSpy).toHaveBeenCalledWith(`Setup go version spec 1.13.0`); | ||||
|   }); | ||||
|  | ||||
|   it('does not export any variables for Go versions >=1.9', async () => { | ||||
|     inputs['go-version'] = '1.13.0'; | ||||
|     inSpy.mockImplementation(name => inputs[name]); | ||||
|  | ||||
|     let toolPath = path.normalize('/cache/go/1.13.0/x64'); | ||||
|     findSpy.mockImplementation(() => toolPath); | ||||
|  | ||||
|     let vars: {[key: string]: string} = {}; | ||||
|     exportVarSpy.mockImplementation((name: string, val: string) => { | ||||
|       vars[name] = val; | ||||
|     }); | ||||
|  | ||||
|     await main.run(); | ||||
|     expect(vars).toStrictEqual({}); | ||||
|   }); | ||||
|  | ||||
|   it('exports GOROOT for Go versions <1.9', async () => { | ||||
|     inputs['go-version'] = '1.8'; | ||||
|     inSpy.mockImplementation(name => inputs[name]); | ||||
|  | ||||
|     let toolPath = path.normalize('/cache/go/1.8.0/x64'); | ||||
|     findSpy.mockImplementation(() => toolPath); | ||||
|  | ||||
|     let vars: {[key: string]: string} = {}; | ||||
|     exportVarSpy.mockImplementation((name: string, val: string) => { | ||||
|       vars[name] = val; | ||||
|     }); | ||||
|  | ||||
|     await main.run(); | ||||
|     expect(vars).toStrictEqual({ | ||||
|       GOROOT: toolPath | ||||
|     }); | ||||
|   }); | ||||
|  | ||||
|   it('finds a version of go already in the cache', async () => { | ||||
| @@ -270,14 +314,14 @@ describe('setup-go', () => { | ||||
|     findSpy.mockImplementation(() => ''); | ||||
|     dlSpy.mockImplementation(() => '/some/temp/path'); | ||||
|     let toolPath = path.normalize('/cache/go/1.13.0/x64'); | ||||
|     exSpy.mockImplementation(() => '/some/other/temp/path'); | ||||
|     extractTarSpy.mockImplementation(() => '/some/other/temp/path'); | ||||
|     cacheSpy.mockImplementation(() => toolPath); | ||||
|     await main.run(); | ||||
|  | ||||
|     let expPath = path.join(toolPath, 'bin'); | ||||
|  | ||||
|     expect(dlSpy).toHaveBeenCalled(); | ||||
|     expect(exSpy).toHaveBeenCalled(); | ||||
|     expect(extractTarSpy).toHaveBeenCalled(); | ||||
|     expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); | ||||
|   }); | ||||
|  | ||||
| @@ -299,7 +343,6 @@ describe('setup-go', () => { | ||||
|     os.platform = 'linux'; | ||||
|     os.arch = 'x64'; | ||||
|  | ||||
|     // a version which is in the manifest | ||||
|     let versionSpec = '1.12.16'; | ||||
|  | ||||
|     inputs['go-version'] = versionSpec; | ||||
| @@ -313,7 +356,7 @@ describe('setup-go', () => { | ||||
|  | ||||
|     dlSpy.mockImplementation(async () => '/some/temp/path'); | ||||
|     let toolPath = path.normalize('/cache/go/1.12.16/x64'); | ||||
|     exSpy.mockImplementation(async () => '/some/other/temp/path'); | ||||
|     extractTarSpy.mockImplementation(async () => '/some/other/temp/path'); | ||||
|     cacheSpy.mockImplementation(async () => toolPath); | ||||
|  | ||||
|     await main.run(); | ||||
| @@ -321,7 +364,7 @@ describe('setup-go', () => { | ||||
|     let expPath = path.join(toolPath, 'bin'); | ||||
|  | ||||
|     expect(dlSpy).toHaveBeenCalled(); | ||||
|     expect(exSpy).toHaveBeenCalled(); | ||||
|     expect(extractTarSpy).toHaveBeenCalled(); | ||||
|     expect(logSpy).not.toHaveBeenCalledWith( | ||||
|       'Not found in manifest.  Falling back to download directly from Go' | ||||
|     ); | ||||
| @@ -337,7 +380,6 @@ describe('setup-go', () => { | ||||
|     os.platform = 'linux'; | ||||
|     os.arch = 'x64'; | ||||
|  | ||||
|     // a version which is in the manifest | ||||
|     let versionSpec = '1.12'; | ||||
|  | ||||
|     inputs['go-version'] = versionSpec; | ||||
| @@ -351,7 +393,7 @@ describe('setup-go', () => { | ||||
|  | ||||
|     dlSpy.mockImplementation(async () => '/some/temp/path'); | ||||
|     let toolPath = path.normalize('/cache/go/1.12.17/x64'); | ||||
|     exSpy.mockImplementation(async () => '/some/other/temp/path'); | ||||
|     extractTarSpy.mockImplementation(async () => '/some/other/temp/path'); | ||||
|     cacheSpy.mockImplementation(async () => toolPath); | ||||
|  | ||||
|     await main.run(); | ||||
| @@ -359,7 +401,7 @@ describe('setup-go', () => { | ||||
|     let expPath = path.join(toolPath, 'bin'); | ||||
|  | ||||
|     expect(dlSpy).toHaveBeenCalled(); | ||||
|     expect(exSpy).toHaveBeenCalled(); | ||||
|     expect(extractTarSpy).toHaveBeenCalled(); | ||||
|     expect(logSpy).not.toHaveBeenCalledWith( | ||||
|       'Not found in manifest.  Falling back to download directly from Go' | ||||
|     ); | ||||
| @@ -375,7 +417,6 @@ describe('setup-go', () => { | ||||
|     os.platform = 'linux'; | ||||
|     os.arch = 'x64'; | ||||
|  | ||||
|     // a version which is not in the manifest but is in node dist | ||||
|     let versionSpec = '1.12.14'; | ||||
|  | ||||
|     inputs['go-version'] = versionSpec; | ||||
| @@ -389,18 +430,18 @@ describe('setup-go', () => { | ||||
|  | ||||
|     dlSpy.mockImplementation(async () => '/some/temp/path'); | ||||
|     let toolPath = path.normalize('/cache/go/1.12.14/x64'); | ||||
|     exSpy.mockImplementation(async () => '/some/other/temp/path'); | ||||
|     extractTarSpy.mockImplementation(async () => '/some/other/temp/path'); | ||||
|     cacheSpy.mockImplementation(async () => toolPath); | ||||
|  | ||||
|     await main.run(); | ||||
|  | ||||
|     let expPath = path.join(toolPath, 'bin'); | ||||
|     expect(logSpy).toHaveBeenCalledWith('Setup go stable version spec 1.12.14'); | ||||
|     expect(logSpy).toHaveBeenCalledWith('Setup go version spec 1.12.14'); | ||||
|     expect(findSpy).toHaveBeenCalled(); | ||||
|     expect(logSpy).toHaveBeenCalledWith('Attempting to download 1.12.14...'); | ||||
|     expect(dlSpy).toHaveBeenCalled(); | ||||
|     expect(logSpy).toHaveBeenCalledWith('matching 1.12.14...'); | ||||
|     expect(exSpy).toHaveBeenCalled(); | ||||
|     expect(extractTarSpy).toHaveBeenCalled(); | ||||
|     expect(logSpy).toHaveBeenCalledWith( | ||||
|       'Not found in manifest.  Falling back to download directly from Go' | ||||
|     ); | ||||
| @@ -497,6 +538,16 @@ describe('setup-go', () => { | ||||
|     expect(annotation.message).toBe('undefined: fmt.Printl'); | ||||
|   }); | ||||
|  | ||||
|   it('matches on unix path down the tree', async () => { | ||||
|     let line = 'foo/main.go:13:2: undefined: fmt.Printl'; | ||||
|     let annotation = testMatch(line); | ||||
|     expect(annotation).toBeDefined(); | ||||
|     expect(annotation.line).toBe(13); | ||||
|     expect(annotation.column).toBe(2); | ||||
|     expect(annotation.file).toBe('foo/main.go'); | ||||
|     expect(annotation.message).toBe('undefined: fmt.Printl'); | ||||
|   }); | ||||
|  | ||||
|   it('matches on rooted unix path', async () => { | ||||
|     let line = '/assert.go:4:1: missing return at end of function'; | ||||
|     let annotation = testMatch(line); | ||||
| @@ -549,11 +600,11 @@ describe('setup-go', () => { | ||||
|  | ||||
|   // 1.13.1 => 1.13.1 | ||||
|   // 1.13 => 1.13.0 | ||||
|   // 1.10beta1 => 1.10.0-beta1, 1.10rc1 => 1.10.0-rc1 | ||||
|   // 1.8.5beta1 => 1.8.5-beta1, 1.8.5rc1 => 1.8.5-rc1 | ||||
|   // 1.10beta1 => 1.10.0-beta.1, 1.10rc1 => 1.10.0-rc.1 | ||||
|   // 1.8.5beta1 => 1.8.5-beta.1, 1.8.5rc1 => 1.8.5-rc.1 | ||||
|   it('converts prerelease versions', async () => { | ||||
|     expect(im.makeSemver('1.10beta1')).toBe('1.10.0-beta1'); | ||||
|     expect(im.makeSemver('1.10rc1')).toBe('1.10.0-rc1'); | ||||
|     expect(im.makeSemver('1.10beta1')).toBe('1.10.0-beta.1'); | ||||
|     expect(im.makeSemver('1.10rc1')).toBe('1.10.0-rc.1'); | ||||
|   }); | ||||
|  | ||||
|   it('converts dot zero versions', async () => { | ||||
| @@ -563,4 +614,230 @@ describe('setup-go', () => { | ||||
|   it('does not convert exact versions', async () => { | ||||
|     expect(im.makeSemver('1.13.1')).toBe('1.13.1'); | ||||
|   }); | ||||
|  | ||||
|   describe('check-latest flag', () => { | ||||
|     it("use local version and don't check manifest if check-latest is not specified", async () => { | ||||
|       os.platform = 'linux'; | ||||
|       os.arch = 'x64'; | ||||
|  | ||||
|       inputs['go-version'] = '1.16'; | ||||
|       inputs['check-latest'] = false; | ||||
|  | ||||
|       const toolPath = path.normalize('/cache/go/1.16.1/x64'); | ||||
|       findSpy.mockReturnValue(toolPath); | ||||
|       await main.run(); | ||||
|  | ||||
|       expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`); | ||||
|       expect(logSpy).not.toHaveBeenCalledWith( | ||||
|         'Attempting to resolve the latest version from the manifest...' | ||||
|       ); | ||||
|     }); | ||||
|  | ||||
|     it('check latest version and resolve it from local cache', async () => { | ||||
|       os.platform = 'linux'; | ||||
|       os.arch = 'x64'; | ||||
|  | ||||
|       inputs['go-version'] = '1.16'; | ||||
|       inputs['check-latest'] = true; | ||||
|  | ||||
|       const toolPath = path.normalize('/cache/go/1.16.1/x64'); | ||||
|       findSpy.mockReturnValue(toolPath); | ||||
|       dlSpy.mockImplementation(async () => '/some/temp/path'); | ||||
|       extractTarSpy.mockImplementation(async () => '/some/other/temp/path'); | ||||
|       cacheSpy.mockImplementation(async () => toolPath); | ||||
|  | ||||
|       await main.run(); | ||||
|  | ||||
|       expect(logSpy).toHaveBeenCalledWith('Setup go version spec 1.16'); | ||||
|       expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`); | ||||
|     }); | ||||
|  | ||||
|     it('check latest version and install it from manifest', async () => { | ||||
|       os.platform = 'linux'; | ||||
|       os.arch = 'x64'; | ||||
|  | ||||
|       const versionSpec = '1.17'; | ||||
|       const patchVersion = '1.17.6'; | ||||
|       inputs['go-version'] = versionSpec; | ||||
|       inputs['stable'] = 'true'; | ||||
|       inputs['check-latest'] = true; | ||||
|  | ||||
|       findSpy.mockImplementation(() => ''); | ||||
|       dlSpy.mockImplementation(async () => '/some/temp/path'); | ||||
|       const toolPath = path.normalize('/cache/go/1.17.5/x64'); | ||||
|       extractTarSpy.mockImplementation(async () => '/some/other/temp/path'); | ||||
|       cacheSpy.mockImplementation(async () => toolPath); | ||||
|       const expectedUrl = | ||||
|         'https://github.com/actions/go-versions/releases/download/1.17.6-1668090892/go-1.17.6-darwin-x64.tar.gz'; | ||||
|  | ||||
|       await main.run(); | ||||
|  | ||||
|       expect(logSpy).toHaveBeenCalledWith( | ||||
|         `Setup go version spec ${versionSpec}` | ||||
|       ); | ||||
|       expect(logSpy).toHaveBeenCalledWith( | ||||
|         'Attempting to resolve the latest version from the manifest...' | ||||
|       ); | ||||
|       expect(logSpy).toHaveBeenCalledWith(`Resolved as '${patchVersion}'`); | ||||
|       expect(logSpy).toHaveBeenCalledWith( | ||||
|         `Attempting to download ${patchVersion}...` | ||||
|       ); | ||||
|       expect(logSpy).toHaveBeenCalledWith('Extracting Go...'); | ||||
|       expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...'); | ||||
|       expect(logSpy).toHaveBeenCalledWith('Added go to the path'); | ||||
|       expect(logSpy).toHaveBeenCalledWith( | ||||
|         `Successfully set up Go version ${versionSpec}` | ||||
|       ); | ||||
|     }); | ||||
|  | ||||
|     it('fallback to dist if version is not found in manifest', async () => { | ||||
|       os.platform = 'linux'; | ||||
|       os.arch = 'x64'; | ||||
|  | ||||
|       let versionSpec = '1.13'; | ||||
|  | ||||
|       inputs['go-version'] = versionSpec; | ||||
|       inputs['check-latest'] = true; | ||||
|       inputs['always-auth'] = false; | ||||
|       inputs['token'] = 'faketoken'; | ||||
|  | ||||
|       // ... but not in the local cache | ||||
|       findSpy.mockImplementation(() => ''); | ||||
|  | ||||
|       dlSpy.mockImplementation(async () => '/some/temp/path'); | ||||
|       let toolPath = path.normalize('/cache/go/1.13.7/x64'); | ||||
|       extractTarSpy.mockImplementation(async () => '/some/other/temp/path'); | ||||
|       cacheSpy.mockImplementation(async () => toolPath); | ||||
|  | ||||
|       await main.run(); | ||||
|  | ||||
|       let expPath = path.join(toolPath, 'bin'); | ||||
|  | ||||
|       expect(dlSpy).toHaveBeenCalled(); | ||||
|       expect(extractTarSpy).toHaveBeenCalled(); | ||||
|       expect(logSpy).toHaveBeenCalledWith( | ||||
|         'Attempting to resolve the latest version from the manifest...' | ||||
|       ); | ||||
|       expect(logSpy).toHaveBeenCalledWith( | ||||
|         `Failed to resolve version ${versionSpec} from manifest` | ||||
|       ); | ||||
|       expect(logSpy).toHaveBeenCalledWith( | ||||
|         `Attempting to download ${versionSpec}...` | ||||
|       ); | ||||
|       expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); | ||||
|     }); | ||||
|  | ||||
|     it('fallback to dist if manifest is not available', async () => { | ||||
|       os.platform = 'linux'; | ||||
|       os.arch = 'x64'; | ||||
|  | ||||
|       let versionSpec = '1.13'; | ||||
|  | ||||
|       process.env['GITHUB_PATH'] = ''; | ||||
|  | ||||
|       inputs['go-version'] = versionSpec; | ||||
|       inputs['check-latest'] = true; | ||||
|       inputs['always-auth'] = false; | ||||
|       inputs['token'] = 'faketoken'; | ||||
|  | ||||
|       // ... but not in the local cache | ||||
|       findSpy.mockImplementation(() => ''); | ||||
|       getManifestSpy.mockImplementation(() => { | ||||
|         throw new Error('Unable to download manifest'); | ||||
|       }); | ||||
|  | ||||
|       dlSpy.mockImplementation(async () => '/some/temp/path'); | ||||
|       let toolPath = path.normalize('/cache/go/1.13.7/x64'); | ||||
|       extractTarSpy.mockImplementation(async () => '/some/other/temp/path'); | ||||
|       cacheSpy.mockImplementation(async () => toolPath); | ||||
|  | ||||
|       await main.run(); | ||||
|  | ||||
|       let expPath = path.join(toolPath, 'bin'); | ||||
|  | ||||
|       expect(logSpy).toHaveBeenCalledWith( | ||||
|         `Failed to resolve version ${versionSpec} from manifest` | ||||
|       ); | ||||
|       expect(dlSpy).toHaveBeenCalled(); | ||||
|       expect(extractTarSpy).toHaveBeenCalled(); | ||||
|       expect(logSpy).toHaveBeenCalledWith( | ||||
|         'Attempting to resolve the latest version from the manifest...' | ||||
|       ); | ||||
|       expect(logSpy).toHaveBeenCalledWith( | ||||
|         'Unable to resolve a version from the manifest...' | ||||
|       ); | ||||
|       expect(logSpy).toHaveBeenCalledWith( | ||||
|         `Failed to resolve version ${versionSpec} from manifest` | ||||
|       ); | ||||
|       expect(logSpy).toHaveBeenCalledWith( | ||||
|         `Attempting to download ${versionSpec}...` | ||||
|       ); | ||||
|  | ||||
|       expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); | ||||
|     }); | ||||
|   }); | ||||
|  | ||||
|   describe('go-version-file', () => { | ||||
|     const goModContents = `module example.com/mymodule | ||||
|  | ||||
| go 1.14 | ||||
|  | ||||
| require ( | ||||
| 	example.com/othermodule v1.2.3 | ||||
| 	example.com/thismodule v1.2.3 | ||||
| 	example.com/thatmodule v1.2.3 | ||||
| ) | ||||
|  | ||||
| replace example.com/thatmodule => ../thatmodule | ||||
| exclude example.com/thismodule v1.3.0 | ||||
| `; | ||||
|  | ||||
|     it('reads version from go.mod', async () => { | ||||
|       inputs['go-version-file'] = 'go.mod'; | ||||
|       existsSpy.mockImplementation(path => true); | ||||
|       readFileSpy.mockImplementation(() => Buffer.from(goModContents)); | ||||
|  | ||||
|       await main.run(); | ||||
|  | ||||
|       expect(logSpy).toHaveBeenCalledWith('Setup go version spec 1.14'); | ||||
|       expect(logSpy).toHaveBeenCalledWith('Attempting to download 1.14...'); | ||||
|       expect(logSpy).toHaveBeenCalledWith('matching 1.14...'); | ||||
|     }); | ||||
|  | ||||
|     it('reads version from .go-version', async () => { | ||||
|       inputs['go-version-file'] = '.go-version'; | ||||
|       existsSpy.mockImplementation(path => true); | ||||
|       readFileSpy.mockImplementation(() => Buffer.from(`1.13.0${osm.EOL}`)); | ||||
|  | ||||
|       await main.run(); | ||||
|  | ||||
|       expect(logSpy).toHaveBeenCalledWith('Setup go version spec 1.13.0'); | ||||
|       expect(logSpy).toHaveBeenCalledWith('Attempting to download 1.13.0...'); | ||||
|       expect(logSpy).toHaveBeenCalledWith('matching 1.13.0...'); | ||||
|     }); | ||||
|  | ||||
|     it('is overwritten by go-version', async () => { | ||||
|       inputs['go-version'] = '1.13.1'; | ||||
|       inputs['go-version-file'] = 'go.mod'; | ||||
|       existsSpy.mockImplementation(path => true); | ||||
|       readFileSpy.mockImplementation(() => Buffer.from(goModContents)); | ||||
|  | ||||
|       await main.run(); | ||||
|  | ||||
|       expect(logSpy).toHaveBeenCalledWith('Setup go version spec 1.13.1'); | ||||
|       expect(logSpy).toHaveBeenCalledWith('Attempting to download 1.13.1...'); | ||||
|       expect(logSpy).toHaveBeenCalledWith('matching 1.13.1...'); | ||||
|     }); | ||||
|  | ||||
|     it('reports a read failure', async () => { | ||||
|       inputs['go-version-file'] = 'go.mod'; | ||||
|       existsSpy.mockImplementation(path => false); | ||||
|  | ||||
|       await main.run(); | ||||
|  | ||||
|       expect(cnSpy).toHaveBeenCalledWith( | ||||
|         `::error::The specified go version file at: go.mod does not exist${osm.EOL}` | ||||
|       ); | ||||
|     }); | ||||
|   }); | ||||
| }); | ||||
|   | ||||
							
								
								
									
										15
									
								
								action.yml
									
									
									
									
									
								
							
							
						
						
									
										15
									
								
								action.yml
									
									
									
									
									
								
							| @@ -1,15 +1,20 @@ | ||||
| name: 'Setup Go environment' | ||||
| description: 'Setup a Go environment and add it to the PATH' | ||||
| author: 'GitHub' | ||||
| inputs:  | ||||
| inputs: | ||||
|   go-version: | ||||
|     description: 'The Go version to download (if necessary) and use. Supports semver spec and ranges.' | ||||
|   stable: | ||||
|     description: 'Whether to download only stable versions' | ||||
|     default: 'true' | ||||
|   go-version-file: | ||||
|     description: 'Path to the go.mod file.' | ||||
|   check-latest: | ||||
|     description: 'Set this option to true if you want the action to always check for the latest available version that satisfies the version spec' | ||||
|     default: false | ||||
|   token: | ||||
|     description: Used to pull node distributions from go-versions.  Since there's a default, this is typically not supplied by the user. | ||||
|     default: ${{ github.token }} | ||||
| outputs: | ||||
|   go-version: | ||||
|     description: 'The installed Go version. Useful when given a version range as input.' | ||||
| runs: | ||||
|   using: 'node12' | ||||
|   using: 'node16' | ||||
|   main: 'dist/index.js' | ||||
|   | ||||
							
								
								
									
										6917
									
								
								dist/index.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										6917
									
								
								dist/index.js
									
									
									
									
										vendored
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										69
									
								
								docs/adrs/0000-caching-dependencies.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										69
									
								
								docs/adrs/0000-caching-dependencies.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,69 @@ | ||||
| # 0. Caching dependencies | ||||
| Date: 2022-04-13 | ||||
|  | ||||
| Status: Accepted | ||||
|  | ||||
| # Context | ||||
| `actions/setup-go` is the one of the most popular action related to Golang in GitHub Actions. Many customers use it in conjunction with [actions/cache](https://github.com/actions/cache) to speed up dependency installation process.   | ||||
| See more examples on proper usage in [actions/cache documentation](https://github.com/actions/cache/blob/main/examples.md#go---modules). | ||||
|  | ||||
| # Goals & Anti-Goals | ||||
| Integration of caching functionality into `actions/setup-go` action will bring the following benefits for action users: | ||||
| - Decrease the entry threshold for using the cache for Go dependencies and simplify initial configuration | ||||
| - Simplify YAML pipelines because there will be no need for additional steps to enable caching | ||||
| - More users will use cache for Go so more customers will have fast builds! | ||||
|  | ||||
| We don't pursue the goal to provide wide customization of caching in scope of `actions/setup-go` action. The purpose of this integration is covering ~90% of basic use-cases. If user needs flexible customization, we should advice them to use `actions/cache` directly. | ||||
|  | ||||
| # Decision | ||||
| - Add `cache` input parameter to `actions/setup-go`. For now, input will accept the following values:  | ||||
|   - `true` - enable caching for go dependencies | ||||
|   - `false`- disable caching for go dependencies. This value will be set as default value | ||||
| - Cache feature will be disabled by default to make sure that we don't break existing customers. We will consider enabling cache by default in next major releases | ||||
| - Action will try to search a go.sum files in the repository and throw error in the scenario that it was not found | ||||
| - The hash of found file will be used as cache key (the same approach like [actions/cache](https://github.com/actions/cache/blob/main/examples.md#go---modules) recommends) | ||||
| - The following key cache will be used `${{ runner.os }}-go${{ go-version }}-${{ hashFiles('<go.sum-path>') }}` | ||||
| - Action will cache global cache from the `go env GOMODCACHE` and `go env GOCACHE` commands. | ||||
| - Add a `cache-dependency-path` input parameter to `actions/setup-go`. The new input will accept an array or regex of dependency files. The field will accept a path (relative to the repository root) to dependency files. If the provided path contains wildcards, the action will search all matching files and calculate a common hash like the ${{ hashFiles('**/go.sum') }} YAML construction does. | ||||
|  | ||||
| # Example of real use-cases | ||||
|  | ||||
|  - With cache | ||||
|  | ||||
| ```yml | ||||
| steps: | ||||
| - uses: actions/checkout@v3 | ||||
| - uses: actions/setup-go@v3 | ||||
|   with: | ||||
|     go-version: '18' | ||||
|     cache: true | ||||
| ``` | ||||
|  | ||||
|  - With cache-dependency-path | ||||
|  | ||||
|  ```yml | ||||
| steps: | ||||
| - uses: actions/checkout@v3 | ||||
| - uses: actions/setup-go@v3 | ||||
|   with: | ||||
|     go-version: '18' | ||||
|     cache: true | ||||
|     cache-dependency-path: **/go.sum | ||||
| ``` | ||||
|  | ||||
|  ```yml | ||||
| steps: | ||||
| - uses: actions/checkout@v3 | ||||
| - uses: actions/setup-go@v3 | ||||
|   with: | ||||
|     go-version: '18' | ||||
|     cache: true | ||||
|     cache-dependency-path: | | ||||
|         **/go.sum | ||||
|         **/go.mod | ||||
| ``` | ||||
|  | ||||
| # Release process | ||||
|  | ||||
| As soon as functionality is implemented, we will release minor update of action. No need to bump major version since there are no breaking changes for existing users. | ||||
| After that, we will update [starter-workflows](https://github.com/actions/starter-workflows/blob/main/ci/go.yml) | ||||
| @@ -4,7 +4,7 @@ | ||||
|             "owner": "go", | ||||
|             "pattern": [ | ||||
|                 { | ||||
|                     "regexp": "^\\s*(\\.{0,2}[\\/\\\\].+\\.go):(?:(\\d+):(\\d+):)? (.*)", | ||||
|                     "regexp": "^\\s*(.+\\.go):(?:(\\d+):(\\d+):)? (.*)", | ||||
|                     "file": 1, | ||||
|                     "line": 2, | ||||
|                     "column": 3, | ||||
| @@ -13,4 +13,4 @@ | ||||
|             ] | ||||
|         } | ||||
|     ] | ||||
| } | ||||
| } | ||||
|   | ||||
							
								
								
									
										16096
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										16096
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										14
									
								
								package.json
									
									
									
									
									
								
							
							
						
						
									
										14
									
								
								package.json
									
									
									
									
									
								
							| @@ -23,22 +23,22 @@ | ||||
|   "author": "GitHub", | ||||
|   "license": "MIT", | ||||
|   "dependencies": { | ||||
|     "@actions/core": "^1.2.6", | ||||
|     "@actions/core": "^1.6.0", | ||||
|     "@actions/http-client": "^1.0.6", | ||||
|     "@actions/io": "^1.0.2", | ||||
|     "@actions/tool-cache": "^1.5.5", | ||||
|     "semver": "^6.1.1" | ||||
|   }, | ||||
|   "devDependencies": { | ||||
|     "@types/jest": "^24.0.13", | ||||
|     "@types/node": "^12.0.4", | ||||
|     "@types/jest": "^27.0.2", | ||||
|     "@types/node": "^16.11.25", | ||||
|     "@types/semver": "^6.0.0", | ||||
|     "@zeit/ncc": "^0.21.0", | ||||
|     "jest": "^25.2.1", | ||||
|     "jest-circus": "^24.7.1", | ||||
|     "@vercel/ncc": "^0.33.4", | ||||
|     "jest": "^27.2.5", | ||||
|     "jest-circus": "^27.2.5", | ||||
|     "nock": "^10.0.6", | ||||
|     "prettier": "^1.17.1", | ||||
|     "ts-jest": "^24.0.2", | ||||
|     "ts-jest": "^27.0.5", | ||||
|     "typescript": "^3.8.3" | ||||
|   } | ||||
| } | ||||
|   | ||||
							
								
								
									
										101
									
								
								src/installer.ts
									
									
									
									
									
								
							
							
						
						
									
										101
									
								
								src/installer.ts
									
									
									
									
									
								
							| @@ -4,6 +4,7 @@ import * as path from 'path'; | ||||
| import * as semver from 'semver'; | ||||
| import * as httpm from '@actions/http-client'; | ||||
| import * as sys from './system'; | ||||
| import fs from 'fs'; | ||||
| import os from 'os'; | ||||
|  | ||||
| type InstallationType = 'dist' | 'manifest'; | ||||
| @@ -30,12 +31,27 @@ export interface IGoVersionInfo { | ||||
|  | ||||
| export async function getGo( | ||||
|   versionSpec: string, | ||||
|   stable: boolean, | ||||
|   checkLatest: boolean, | ||||
|   auth: string | undefined | ||||
| ) { | ||||
|   let osPlat: string = os.platform(); | ||||
|   let osArch: string = os.arch(); | ||||
|  | ||||
|   if (checkLatest) { | ||||
|     core.info('Attempting to resolve the latest version from the manifest...'); | ||||
|     const resolvedVersion = await resolveVersionFromManifest( | ||||
|       versionSpec, | ||||
|       true, | ||||
|       auth | ||||
|     ); | ||||
|     if (resolvedVersion) { | ||||
|       versionSpec = resolvedVersion; | ||||
|       core.info(`Resolved as '${versionSpec}'`); | ||||
|     } else { | ||||
|       core.info(`Failed to resolve version ${versionSpec} from manifest`); | ||||
|     } | ||||
|   } | ||||
|  | ||||
|   // check cache | ||||
|   let toolPath: string; | ||||
|   toolPath = tc.find('go', versionSpec); | ||||
| @@ -52,7 +68,7 @@ export async function getGo( | ||||
|   // Try download from internal distribution (popular versions only) | ||||
|   // | ||||
|   try { | ||||
|     info = await getInfoFromManifest(versionSpec, stable, auth); | ||||
|     info = await getInfoFromManifest(versionSpec, true, auth); | ||||
|     if (info) { | ||||
|       downloadPath = await installGoVersion(info, auth); | ||||
|     } else { | ||||
| @@ -79,7 +95,7 @@ export async function getGo( | ||||
|   // Download from storage.googleapis.com | ||||
|   // | ||||
|   if (!downloadPath) { | ||||
|     info = await getInfoFromDist(versionSpec, stable); | ||||
|     info = await getInfoFromDist(versionSpec); | ||||
|     if (!info) { | ||||
|       throw new Error( | ||||
|         `Unable to find Go version '${versionSpec}' for platform ${osPlat} and architecture ${osArch}.` | ||||
| @@ -97,6 +113,20 @@ export async function getGo( | ||||
|   return downloadPath; | ||||
| } | ||||
|  | ||||
| async function resolveVersionFromManifest( | ||||
|   versionSpec: string, | ||||
|   stable: boolean, | ||||
|   auth: string | undefined | ||||
| ): Promise<string | undefined> { | ||||
|   try { | ||||
|     const info = await getInfoFromManifest(versionSpec, stable, auth); | ||||
|     return info?.resolvedVersion; | ||||
|   } catch (err) { | ||||
|     core.info('Unable to resolve a version from the manifest...'); | ||||
|     core.debug(err.message); | ||||
|   } | ||||
| } | ||||
|  | ||||
| async function installGoVersion( | ||||
|   info: IGoVersionInfo, | ||||
|   auth: string | undefined | ||||
| @@ -122,10 +152,10 @@ async function installGoVersion( | ||||
| } | ||||
|  | ||||
| export async function extractGoArchive(archivePath: string): Promise<string> { | ||||
|   const arch = os.arch(); | ||||
|   const platform = os.platform(); | ||||
|   let extPath: string; | ||||
|  | ||||
|   if (arch === 'win32') { | ||||
|   if (platform === 'win32') { | ||||
|     extPath = await tc.extractZip(archivePath); | ||||
|   } else { | ||||
|     extPath = await tc.extractTar(archivePath); | ||||
| @@ -161,11 +191,10 @@ export async function getInfoFromManifest( | ||||
| } | ||||
|  | ||||
| async function getInfoFromDist( | ||||
|   versionSpec: string, | ||||
|   stable: boolean | ||||
|   versionSpec: string | ||||
| ): Promise<IGoVersionInfo | null> { | ||||
|   let version: IGoVersion | undefined; | ||||
|   version = await findMatch(versionSpec, stable); | ||||
|   version = await findMatch(versionSpec); | ||||
|   if (!version) { | ||||
|     return null; | ||||
|   } | ||||
| @@ -181,8 +210,7 @@ async function getInfoFromDist( | ||||
| } | ||||
|  | ||||
| export async function findMatch( | ||||
|   versionSpec: string, | ||||
|   stable: boolean | ||||
|   versionSpec: string | ||||
| ): Promise<IGoVersion | undefined> { | ||||
|   let archFilter = sys.getArch(); | ||||
|   let platFilter = sys.getPlatform(); | ||||
| @@ -203,18 +231,8 @@ export async function findMatch( | ||||
|     let candidate: IGoVersion = candidates[i]; | ||||
|     let version = makeSemver(candidate.version); | ||||
|  | ||||
|     // 1.13.0 is advertised as 1.13 preventing being able to match exactly 1.13.0 | ||||
|     // since a semver of 1.13 would match latest 1.13 | ||||
|     let parts: string[] = version.split('.'); | ||||
|     if (parts.length == 2) { | ||||
|       version = version + '.0'; | ||||
|     } | ||||
|  | ||||
|     core.debug(`check ${version} satisfies ${versionSpec}`); | ||||
|     if ( | ||||
|       semver.satisfies(version, versionSpec) && | ||||
|       (!stable || candidate.stable === stable) | ||||
|     ) { | ||||
|     if (semver.satisfies(version, versionSpec)) { | ||||
|       goFile = candidate.files.find(file => { | ||||
|         core.debug( | ||||
|           `${file.arch}===${archFilter} && ${file.os}===${platFilter}` | ||||
| @@ -254,20 +272,41 @@ export async function getVersionsDist( | ||||
| // Convert the go version syntax into semver for semver matching | ||||
| // 1.13.1 => 1.13.1 | ||||
| // 1.13 => 1.13.0 | ||||
| // 1.10beta1 => 1.10.0-beta1, 1.10rc1 => 1.10.0-rc1 | ||||
| // 1.8.5beta1 => 1.8.5-beta1, 1.8.5rc1 => 1.8.5-rc1 | ||||
| // 1.10beta1 => 1.10.0-beta.1, 1.10rc1 => 1.10.0-rc.1 | ||||
| // 1.8.5beta1 => 1.8.5-beta.1, 1.8.5rc1 => 1.8.5-rc.1 | ||||
| export function makeSemver(version: string): string { | ||||
|   version = version.replace('go', ''); | ||||
|   version = version.replace('beta', '-beta').replace('rc', '-rc'); | ||||
|   version = version.replace('beta', '-beta.').replace('rc', '-rc.'); | ||||
|   let parts = version.split('-'); | ||||
|  | ||||
|   let verPart: string = parts[0]; | ||||
|   let prereleasePart = parts.length > 1 ? `-${parts[1]}` : ''; | ||||
|  | ||||
|   let verParts: string[] = verPart.split('.'); | ||||
|   if (verParts.length == 2) { | ||||
|     verPart += '.0'; | ||||
|   let semVersion = semver.coerce(parts[0])?.version; | ||||
|   if (!semVersion) { | ||||
|     throw new Error( | ||||
|       `The version: ${version} can't be changed to SemVer notation` | ||||
|     ); | ||||
|   } | ||||
|  | ||||
|   return `${verPart}${prereleasePart}`; | ||||
|   if (!parts[1]) { | ||||
|     return semVersion; | ||||
|   } | ||||
|  | ||||
|   const fullVersion = semver.valid(`${semVersion}-${parts[1]}`); | ||||
|  | ||||
|   if (!fullVersion) { | ||||
|     throw new Error( | ||||
|       `The version: ${version} can't be changed to SemVer notation` | ||||
|     ); | ||||
|   } | ||||
|   return fullVersion; | ||||
| } | ||||
|  | ||||
| export function parseGoVersionFile(versionFilePath: string): string { | ||||
|   const contents = fs.readFileSync(versionFilePath).toString(); | ||||
|  | ||||
|   if (path.basename(versionFilePath) === 'go.mod') { | ||||
|     const match = contents.match(/^go (\d+(\.\d+)*)/m); | ||||
|     return match ? match[1] : ''; | ||||
|   } | ||||
|  | ||||
|   return contents.trim(); | ||||
| } | ||||
|   | ||||
							
								
								
									
										64
									
								
								src/main.ts
									
									
									
									
									
								
							
							
						
						
									
										64
									
								
								src/main.ts
									
									
									
									
									
								
							| @@ -1,6 +1,7 @@ | ||||
| import * as core from '@actions/core'; | ||||
| import * as io from '@actions/io'; | ||||
| import * as installer from './installer'; | ||||
| import * as semver from 'semver'; | ||||
| import path from 'path'; | ||||
| import cp from 'child_process'; | ||||
| import fs from 'fs'; | ||||
| @@ -12,27 +13,30 @@ export async function run() { | ||||
|     // versionSpec is optional.  If supplied, install / use from the tool cache | ||||
|     // If not supplied then problem matchers will still be setup.  Useful for self-hosted. | ||||
|     // | ||||
|     let versionSpec = core.getInput('go-version'); | ||||
|     const versionSpec = resolveVersionInput(); | ||||
|  | ||||
|     // stable will be true unless false is the exact input | ||||
|     // since getting unstable versions should be explicit | ||||
|     let stable = (core.getInput('stable') || 'true').toUpperCase() === 'TRUE'; | ||||
|  | ||||
|     core.info(`Setup go ${stable ? 'stable' : ''} version spec ${versionSpec}`); | ||||
|     core.info(`Setup go version spec ${versionSpec}`); | ||||
|  | ||||
|     if (versionSpec) { | ||||
|       let token = core.getInput('token'); | ||||
|       let auth = !token || isGhes() ? undefined : `token ${token}`; | ||||
|  | ||||
|       const installDir = await installer.getGo(versionSpec, stable, auth); | ||||
|       const checkLatest = core.getBooleanInput('check-latest'); | ||||
|       const installDir = await installer.getGo(versionSpec, checkLatest, auth); | ||||
|  | ||||
|       core.exportVariable('GOROOT', installDir); | ||||
|       core.addPath(path.join(installDir, 'bin')); | ||||
|       core.info('Added go to the path'); | ||||
|  | ||||
|       const version = installer.makeSemver(versionSpec); | ||||
|       // Go versions less than 1.9 require GOROOT to be set | ||||
|       if (semver.lt(version, '1.9.0')) { | ||||
|         core.info('Setting GOROOT for Go version < 1.9'); | ||||
|         core.exportVariable('GOROOT', installDir); | ||||
|       } | ||||
|  | ||||
|       let added = await addBinToPath(); | ||||
|       core.debug(`add bin ${added}`); | ||||
|       core.info(`Successfully setup go version ${versionSpec}`); | ||||
|       core.info(`Successfully set up Go version ${versionSpec}`); | ||||
|     } | ||||
|  | ||||
|     // add problem matchers | ||||
| @@ -44,6 +48,8 @@ export async function run() { | ||||
|     let goVersion = (cp.execSync(`${goPath} version`) || '').toString(); | ||||
|     core.info(goVersion); | ||||
|  | ||||
|     core.setOutput('go-version', parseGoVersion(goVersion)); | ||||
|  | ||||
|     core.startGroup('go env'); | ||||
|     let goEnv = (cp.execSync(`${goPath} env`) || '').toString(); | ||||
|     core.info(goEnv); | ||||
| @@ -63,19 +69,19 @@ export async function addBinToPath(): Promise<boolean> { | ||||
|   } | ||||
|  | ||||
|   let buf = cp.execSync('go env GOPATH'); | ||||
|   if (buf) { | ||||
|   if (buf.length > 1) { | ||||
|     let gp = buf.toString().trim(); | ||||
|     core.debug(`go env GOPATH :${gp}:`); | ||||
|     if (!fs.existsSync(gp)) { | ||||
|       // some of the hosted images have go install but not profile dir | ||||
|       core.debug(`creating ${gp}`); | ||||
|       io.mkdirP(gp); | ||||
|       await io.mkdirP(gp); | ||||
|     } | ||||
|  | ||||
|     let bp = path.join(gp, 'bin'); | ||||
|     if (!fs.existsSync(bp)) { | ||||
|       core.debug(`creating ${bp}`); | ||||
|       io.mkdirP(bp); | ||||
|       await io.mkdirP(bp); | ||||
|     } | ||||
|  | ||||
|     core.addPath(bp); | ||||
| @@ -90,3 +96,37 @@ function isGhes(): boolean { | ||||
|   ); | ||||
|   return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM'; | ||||
| } | ||||
|  | ||||
| export function parseGoVersion(versionString: string): string { | ||||
|   // get the installed version as an Action output | ||||
|   // based on go/src/cmd/go/internal/version/version.go: | ||||
|   // fmt.Printf("go version %s %s/%s\n", runtime.Version(), runtime.GOOS, runtime.GOARCH) | ||||
|   // expecting go<version> for runtime.Version() | ||||
|   return versionString.split(' ')[2].slice('go'.length); | ||||
| } | ||||
|  | ||||
| function resolveVersionInput(): string { | ||||
|   let version = core.getInput('go-version'); | ||||
|   const versionFilePath = core.getInput('go-version-file'); | ||||
|  | ||||
|   if (version && versionFilePath) { | ||||
|     core.warning( | ||||
|       'Both go-version and go-version-file inputs are specified, only go-version will be used' | ||||
|     ); | ||||
|   } | ||||
|  | ||||
|   if (version) { | ||||
|     return version; | ||||
|   } | ||||
|  | ||||
|   if (versionFilePath) { | ||||
|     if (!fs.existsSync(versionFilePath)) { | ||||
|       throw new Error( | ||||
|         `The specified go version file at: ${versionFilePath} does not exist` | ||||
|       ); | ||||
|     } | ||||
|     version = installer.parseGoVersionFile(versionFilePath); | ||||
|   } | ||||
|  | ||||
|   return version; | ||||
| } | ||||
|   | ||||
| @@ -1,4 +1,4 @@ | ||||
| let os = require('os'); | ||||
| const os = require('os'); | ||||
|  | ||||
| export function getPlatform(): string { | ||||
|   // darwin and linux match already | ||||
|   | ||||
| @@ -4,9 +4,6 @@ | ||||
|     // "incremental": true,                   /* Enable incremental compilation */ | ||||
|     "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */ | ||||
|     "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */ | ||||
|     "lib": [ | ||||
|       "es6" | ||||
|     ], | ||||
|     // "allowJs": true,                       /* Allow javascript files to be compiled. */ | ||||
|     // "checkJs": true,                       /* Report errors in .js files. */ | ||||
|     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ | ||||
| @@ -48,7 +45,8 @@ | ||||
|     // "typeRoots": [],                       /* List of folders to include type definitions from. */ | ||||
|     // "types": [],                           /* Type declaration files to be included in compilation. */ | ||||
|     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ | ||||
|     "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ | ||||
|     "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ | ||||
|     "sourceMap": true, | ||||
|     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */ | ||||
|     // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */ | ||||
|  | ||||
|   | ||||
		Reference in New Issue
	
	Block a user