Skip to content

Commit cdcb360

Browse files
authored
Remove the description of the old go.mod specification (#458)
* Fix emoji rendering * Fix quoting * Remove the description of the old go.mod specification * Remove the single quotes from `go-version-file` * Fix README * Add description about patch versions to README * Revert "Remove the single quotes from `go-version-file`" This reverts commit ca4321a.
1 parent 99176a8 commit cdcb360

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

README.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,10 @@ steps:
7070
>
7171
> ```yaml
7272
> go-version: '1.20'
73-
> ```
73+
> ```
7474
>
7575
> The recommendation is based on the YAML parser's behavior, which interprets non-wrapped values as numbers and, in the case of version 1.20, trims it down to 1.2, which may not be very obvious.
76+
7677
Matching an unstable pre-release:
7778

7879
```yaml
@@ -190,11 +191,13 @@ steps:
190191

191192
## Getting go version from the go.mod file
192193

193-
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
194-
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
195-
latest available patch version sequentially in the runner's directory with the cached tools, in
196-
the [versions-manifest.json](https://github.com/actions/go-versions/blob/main/versions-manifest.json) file or at the go
197-
servers.
194+
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.
195+
196+
The `go` directive in `go.mod` can specify a patch version or omit it altogether (e.g., `go 1.22.0` or `go 1.22`).
197+
If a patch version is specified, that specific patch version will be used.
198+
If no patch version is specified, it will search for the latest available patch version in the cache,
199+
[versions-manifest.json](https://github.com/actions/go-versions/blob/main/versions-manifest.json), and the
200+
[official Go language website](https://golang.org/dl/?mode=json&include=all), in that order.
198201

199202
If both the `go-version` and the `go-version-file` inputs are provided then the `go-version` input is used.
200203
> The action will search for the `go.mod` file relative to the repository root

docs/contributors.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ We have prepared a short guide so that the process of making your contribution i
66

77
## How can I contribute...
88

9-
* [Contribute Documentation:green_book:](#contribute-documentation)
9+
* [Contribute Documentation :green_book:](#contribute-documentation)
1010

1111
* [Contribute Code :computer:](#contribute-code)
1212

13-
* [Provide Support on Issues:pencil:](#provide-support-on-issues)
13+
* [Provide Support on Issues :pencil:](#provide-support-on-issues)
1414

15-
* [Review Pull Requests:mag:](#review-pull-requests)
15+
* [Review Pull Requests :mag:](#review-pull-requests)
1616

1717
## Contribute documentation
1818

@@ -113,4 +113,4 @@ Another great way to contribute is pull request reviews. Please, be extra kind:
113113
- Make sure you're familiar with the code or documentation is updated, unless it's a minor change (spellchecking, minor formatting, etc.)
114114
- Review changes using the GitHub functionality. You can ask a clarifying question, point out an error or suggest an alternative.
115115
> Note: You may ask for minor changes - "nitpicks", but consider whether they are real blockers to merging or not
116-
- Submit your review, which may include comments, an approval, or a changes request
116+
- Submit your review, which may include comments, an approval, or a changes request

0 commit comments

Comments
 (0)