From cdcb36043654635271a94b9a6d1392de5bb323a7 Mon Sep 17 00:00:00 2001 From: Masahiro Furudate <178inaba.git@gmail.com> Date: Thu, 18 Apr 2024 22:33:57 +0900 Subject: [PATCH] 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 ca4321abee075cc5dac53a3ef10d60b107460c56. --- README.md | 15 +++++++++------ docs/contributors.md | 8 ++++---- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index eb8f9f3..44726a6 100644 --- a/README.md +++ b/README.md @@ -70,9 +70,10 @@ steps: > > ```yaml > go-version: '1.20' -> ``` +> ``` > > 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. + Matching an unstable pre-release: ```yaml @@ -190,11 +191,13 @@ steps: ## 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 [versions-manifest.json](https://github.com/actions/go-versions/blob/main/versions-manifest.json) file or at the go -servers. +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. + +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`). +If a patch version is specified, that specific patch version will be used. +If no patch version is specified, it will search for the latest available patch version in the cache, +[versions-manifest.json](https://github.com/actions/go-versions/blob/main/versions-manifest.json), and the +[official Go language website](https://golang.org/dl/?mode=json&include=all), in that order. 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 diff --git a/docs/contributors.md b/docs/contributors.md index db70597..4341212 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -6,13 +6,13 @@ We have prepared a short guide so that the process of making your contribution i ## How can I contribute... -* [Contribute Documentation:green_book:](#contribute-documentation) +* [Contribute Documentation :green_book:](#contribute-documentation) * [Contribute Code :computer:](#contribute-code) -* [Provide Support on Issues:pencil:](#provide-support-on-issues) +* [Provide Support on Issues :pencil:](#provide-support-on-issues) -* [Review Pull Requests:mag:](#review-pull-requests) +* [Review Pull Requests :mag:](#review-pull-requests) ## Contribute documentation @@ -113,4 +113,4 @@ Another great way to contribute is pull request reviews. Please, be extra kind: - Make sure you're familiar with the code or documentation is updated, unless it's a minor change (spellchecking, minor formatting, etc.) - Review changes using the GitHub functionality. You can ask a clarifying question, point out an error or suggest an alternative. > Note: You may ask for minor changes - "nitpicks", but consider whether they are real blockers to merging or not -- Submit your review, which may include comments, an approval, or a changes request \ No newline at end of file +- Submit your review, which may include comments, an approval, or a changes request