setup-go/README.md

152 lines
4.8 KiB
Markdown
Raw Normal View History

2019-07-17 16:50:58 +02:00
# setup-go
2019-06-19 15:44:17 +02:00
[![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)
2019-08-12 21:13:31 +02:00
2019-07-17 16:50:58 +02:00
This action sets up a go environment for use in actions by:
2019-06-19 15:44:17 +02:00
- Optionally downloading and caching a version of Go by version and adding to `PATH`.
- Registering problem matchers for error output.
2019-07-17 16:50:58 +02:00
2022-03-25 09:53:28 +01:00
# V3
2020-02-09 20:39:34 +01:00
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)
2020-02-09 20:39:34 +01:00
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).
2022-04-20 16:11:14 +02:00
**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):
2020-02-09 20:39:34 +01:00
```yaml
steps:
- uses: actions/checkout@v3
2022-03-25 09:53:28 +01:00
- uses: actions/setup-go@v3
2021-11-08 11:28:08 +01:00
with:
go-version: '^1.13.1' # The Go version to download (if necessary) and use.
- run: go version
2020-02-09 20:39:34 +01:00
```
```yaml
steps:
- uses: actions/checkout@v3
- uses: actions/setup-go@v3
with:
go-version: '>=1.17.0'
- run: go version
```
2020-02-11 01:18:01 +01:00
Matching an unstable pre-release:
2020-02-11 01:18:01 +01:00
```yaml
steps:
- 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
2022-03-25 09:53:28 +01:00
- uses: actions/setup-go@v3
2021-11-08 11:28:08 +01:00
with:
go-version: '1.16.0-beta.1' # The Go version to download (if necessary) and use.
2021-11-08 11:28:08 +01:00
- run: go version
2020-02-11 01:18:01 +01:00
```
2019-07-17 16:50:58 +02:00
# Usage
See [action.yml](action.yml)
## Basic
2019-07-17 16:50:58 +02:00
```yaml
2019-07-26 03:28:46 +02:00
steps:
- uses: actions/checkout@v3
2022-03-25 09:53:28 +01:00
- 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
```
## 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
2022-03-25 09:53:28 +01:00
- uses: actions/setup-go@v3
2021-11-08 11:28:08 +01:00
with:
go-version: '1.14'
check-latest: true
2021-11-08 11:28:08 +01:00
- run: go run hello.go
2019-07-17 16:50:58 +02:00
```
2022-05-12 10:04:39 +02:00
## 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
```
2019-07-17 16:50:58 +02:00
## Matrix testing
2019-07-17 16:50:58 +02:00
```yaml
jobs:
build:
runs-on: ubuntu-latest
2019-07-17 16:50:58 +02:00
strategy:
matrix:
2020-07-22 13:52:29 +02:00
go: [ '1.14', '1.13' ]
2019-07-17 16:50:58 +02:00
name: Go ${{ matrix.go }} sample
2019-07-26 03:28:46 +02:00
steps:
- uses: actions/checkout@v3
2019-07-17 16:50:58 +02:00
- name: Setup go
2022-03-25 09:53:28 +01:00
uses: actions/setup-go@v3
2019-07-17 16:50:58 +02:00
with:
2019-08-13 22:31:11 +02:00
go-version: ${{ matrix.go }}
2019-07-17 16:50:58 +02:00
- run: go run hello.go
```
2019-06-19 15:44:17 +02:00
### 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.
2019-06-19 15:44:17 +02: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 06:21:39 +01:00
## Code of Conduct
:wave: Be nice. See [our code of conduct](CONDUCT)