setup-go/README.md

86 lines
2 KiB
Markdown
Raw Normal View History

2019-07-17 14:50:58 +00:00
# setup-go
2019-06-19 13:44:17 +00:00
2019-08-12 19:13:31 +00:00
<p align="left">
2020-02-09 05:21:39 +00:00
<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>
2019-08-12 19:13:31 +00:00
</p>
2019-07-17 14:50:58 +00:00
This action sets up a go environment for use in actions by:
2019-06-19 13:44:17 +00:00
2019-08-13 20:31:11 +00:00
- optionally downloading and caching a version of Go by version and adding to PATH
2019-07-17 14:50:58 +00:00
- registering problem matchers for error output
2020-04-16 22:52:17 +00:00
# V2
2020-02-09 19:39:34 +00:00
2020-04-16 22:52:17 +00:00
The V2 offers:
- Adds GOBIN to the PATH
2020-02-09 19:39:34 +00:00
- Proxy Support
- stable input
- Bug Fixes (including issues around version matching and semver)
2020-02-11 00:18:01 +00:00
Matching by semver spec:
2020-02-09 19:39:34 +00:00
```yaml
steps:
- uses: actions/checkout@v2
2020-04-16 22:52:49 +00:00
- uses: actions/setup-go@v2
2020-02-09 19:39:34 +00:00
with:
go-version: '^1.13.1' # The Go version to download (if necessary) and use.
- run: go version
```
2020-02-11 00:18:01 +00:00
Matching an unstable pre-release:
```yaml
steps:
- uses: actions/checkout@v2
2020-04-16 22:52:49 +00:00
- uses: actions/setup-go@v2
2020-02-11 00:18:01 +00:00
with:
stable: 'false'
go-version: '1.14.0-rc1' # The Go version to download (if necessary) and use.
- run: go version
```
2019-07-17 14:50:58 +00:00
# Usage
See [action.yml](action.yml)
Basic:
```yaml
2019-07-26 01:28:46 +00:00
steps:
2019-07-23 19:46:37 +00:00
- uses: actions/checkout@master
2019-08-01 13:19:30 +00:00
- uses: actions/setup-go@v1
2019-07-17 14:50:58 +00:00
with:
2019-08-16 14:21:05 +00:00
go-version: '1.9.3' # The Go version to download (if necessary) and use.
2019-07-17 14:50:58 +00:00
- run: go run hello.go
```
Matrix Testing:
```yaml
jobs:
build:
2019-08-01 15:05:15 +00:00
runs-on: ubuntu-16.04
2019-07-17 14:50:58 +00:00
strategy:
matrix:
2020-02-09 05:21:39 +00:00
go: [ '1.13', '1.12' ]
2019-07-17 14:50:58 +00:00
name: Go ${{ matrix.go }} sample
2019-07-26 01:28:46 +00:00
steps:
2020-02-09 05:21:39 +00:00
- uses: actions/checkout@v2
2019-07-17 14:50:58 +00:00
- name: Setup go
2019-08-01 13:19:30 +00:00
uses: actions/setup-go@v1
2019-07-17 14:50:58 +00:00
with:
2019-08-13 20:31:11 +00:00
go-version: ${{ matrix.go }}
2019-07-17 14:50:58 +00:00
- run: go run hello.go
```
2019-06-19 13:44:17 +00:00
# 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)
2020-02-09 05:21:39 +00:00
## Code of Conduct
:wave: Be nice. See [our code of conduct](CONDUCT)