From dcb4ec94ce957a5303565555e54f942163d41ed8 Mon Sep 17 00:00:00 2001 From: Peter Mescalchin Date: Fri, 1 Apr 2022 06:29:52 +1100 Subject: [PATCH] Bump GitHub actions, `README.md` cleanups (#202) * Bump `actions/checkout@v3` * Bump `actions/setup-node@v3` * Bump `actions/upload-artifact@v3` * Bump `actions/setup-go@v3` in `README.md` examples * Removed mention of `stable` action argument from `README.md` * Add "new style" workflow build buttons to `README.md` --- .github/workflows/check-dist.yml | 6 +++--- .github/workflows/licensed.yml | 4 ++-- .github/workflows/versions.yml | 12 ++++++------ .github/workflows/workflow.yml | 4 ++-- README.md | 28 +++++++++++++++------------- 5 files changed, 28 insertions(+), 26 deletions(-) diff --git a/.github/workflows/check-dist.yml b/.github/workflows/check-dist.yml index 0816ccb..7be140a 100644 --- a/.github/workflows/check-dist.yml +++ b/.github/workflows/check-dist.yml @@ -21,10 +21,10 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Set Node.js 16.x - uses: actions/setup-node@v2 + uses: actions/setup-node@v3 with: node-version: 16.x @@ -44,7 +44,7 @@ jobs: id: diff # If index.js was different than expected, upload the expected version as an artifact - - uses: actions/upload-artifact@v2 + - uses: actions/upload-artifact@v3 if: ${{ failure() && steps.diff.conclusion == 'failure' }} with: name: dist diff --git a/.github/workflows/licensed.yml b/.github/workflows/licensed.yml index 55402d9..3662014 100644 --- a/.github/workflows/licensed.yml +++ b/.github/workflows/licensed.yml @@ -13,9 +13,9 @@ jobs: 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@v2 + uses: actions/setup-node@v3 with: node-version: 16.x - run: npm ci diff --git a/.github/workflows/versions.yml b/.github/workflows/versions.yml index c0bb369..79683ec 100644 --- a/.github/workflows/versions.yml +++ b/.github/workflows/versions.yml @@ -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: ./ @@ -41,7 +41,7 @@ jobs: os: [ubuntu-latest, windows-latest, macos-latest] go-version: [1.16, 1.17] steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup Go and check latest uses: ./ with: @@ -60,13 +60,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 @@ -81,7 +81,7 @@ jobs: go: [1.9, 1.8.6] steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: setup-go ${{ matrix.go }} uses: ./ diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml index 9e18f39..df67fa8 100644 --- a/.github/workflows/workflow.yml +++ b/.github/workflows/workflow.yml @@ -17,10 +17,10 @@ jobs: operating-system: [ubuntu-latest, windows-latest] steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Setup node 16 - uses: actions/setup-node@v2 + uses: actions/setup-node@v3 with: node-version: 16 cache: npm diff --git a/README.md b/README.md index ee5557b..5fa3625 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,26 @@ # setup-go -

- GitHub Actions status - - versions status -

+[![build-test](https://github.com/actions/setup-go/actions/workflows/workflow.yml/badge.svg)](https://github.com/actions/setup-go/actions/workflows/workflow.yml) +[![Validate 'setup-go'](https://github.com/actions/setup-go/actions/workflows/versions.yml/badge.svg)](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. # V3 -The V3 offers: -- Adds GOBIN to the PATH -- Proxy Support +The V3 edition of the action offers: + +- Adds `GOBIN` to the `PATH` +- Proxy support - Check latest version -- Bug Fixes (including issues around version matching and semver) +- 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). Matching by [semver spec](https://github.com/npm/node-semver): + ```yaml steps: - uses: actions/checkout@v3 @@ -64,6 +63,7 @@ steps: See [action.yml](action.yml) ## Basic: + ```yaml steps: - uses: actions/checkout@v3 @@ -74,7 +74,7 @@ steps: ``` -## Check latest version: +## 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. @@ -93,6 +93,7 @@ steps: ``` ## Matrix Testing: + ```yaml jobs: build: @@ -111,9 +112,10 @@ jobs: ``` ### 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` +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 [semver](https://github.com/npm/node-semver) documentation