Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: go-version-file for other use cases #295

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

docs: go-version-file for other use cases #295

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ad27ba4
docs: go-version-file for other use cases
v1v Nov 30, 2022
ef084a2
Update README.md
v1v Nov 30, 2022
4878e37
Merge remote-tracking branch 'upstream/main' into feature/go-file-ver…
v1v Aug 15, 2023
fde5dd2
add go-version output when using go.mod
v1v Aug 15, 2023
721bdf3
docs: add tiny reference for the .tool-versions
v1v Aug 15, 2023
0fc6876
docs: multiline sentence
v1v Aug 15, 2023
b544d3a
add link to the .tool-versions
v1v Aug 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,11 +125,16 @@ steps:
cache-dependency-path: subdir/go.sum
- 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 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 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.
## Getting go version from a file

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 go.mod file

The `go-version-file` input accepts a path to a `go.mod` 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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could be useful to mention the go-version output here

setup-go/action.yml

Line 23 in 41c2024

go-version:

as it makes it easier to know what go version was resolved to from the go.mod file

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See fde5dd2


> The action will search for the `go.mod` file relative to the repository root

```yaml
Expand All @@ -141,6 +146,21 @@ steps:
- run: go version
```

### If a different file

The `go-version-file` input accepts a path to a file file that contains the version of Go to be used by a project. It supports either major and minor (e.g 1.18) or major, minor and patch (e.g 1.18.7) tags
v1v marked this conversation as resolved.
Show resolved Hide resolved

> The action will search for the `.go-version` file relative to the repository root

```yaml
steps:
- uses: actions/checkout@v3
- uses: actions/setup-go@v3
with:
go-version-file: 'path/to/.go-version'
- run: go version
```

## Matrix testing

```yaml
Expand Down