actions/go
1
0
Fork 0
mirror of https://github.com/actions/setup-go.git synced 2024-11-25 14:20:56 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

docs: multiline sentence

Browse source 
add example for using .tool-versions
This commit is contained in:
Victor Martinez 2023-08-15 14:32:29 +02:00
parent 721bdf3e4e
commit 0fc6876467
No known key found for this signature in database
GPG key ID: 419518ED0DA3CBCF
1 changed files with 17 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -179,11 +179,14 @@ steps:
If both the `go-version` and the `go-version-file` inputs are provided then the `go-version` input is used. If both the `go-version` and the `go-version-file` inputs are provided then the `go-version` input is used.
If the 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 the 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 the go.mod or .tool-versions files ### If the go.mod or .tool-versions files
The `go-version-file` input accepts a path to a `go.mod` file, `.tool-versions` file or a `go.work` file that contains 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 follow the above-mentioned approach. The `go-version-file` input accepts a path to a `go.mod` file, `.tool-versions` file or a `go.work` file that contains 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 follow the above-mentioned approach.
> The action will search for the `go.mod` file relative to the repository root > The action will search for the `go.mod` file relative to the repository root
@ -196,7 +199,18 @@ steps:
- run: go version - run: go version
``` ```
Finally, the `go-version` output contains the resolved Golang version from the `go.mod` file. The `go-version` output contains the resolved Golang version from the `go.mod` file.
> The action will search for the `.tool-versions` file relative to the repository root
```yaml
steps:
- uses: actions/checkout@v3
- uses: actions/setup-go@v4
with:
go-version-file: '.tool-versions'
- run: go version
```
### If a different file ### If a different file