From 0fc68764677ba58e54f6823bdee35545d976dc5c Mon Sep 17 00:00:00 2001 From: Victor Martinez Date: Tue, 15 Aug 2023 14:32:29 +0200 Subject: [PATCH] docs: multiline sentence add example for using .tool-versions --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 903e83f..e7d2c0c 100644 --- a/README.md +++ b/README.md @@ -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 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 -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 @@ -196,7 +199,18 @@ steps: - 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