Skip to content

Commit f6334dc

Browse files
Revisit the whole latest vs. rc- vs. strict definition
1 parent abc3213 commit f6334dc

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,21 +53,25 @@ end up being parsed as `23`, which is not equivalent.
5353

5454
#### Pre-release versions
5555

56-
For pre-release versions, such as `v1.11.0-rc.0`, use the full version
57-
specifier (`v1.11.0-rc.0`) and set option `version-type` to `strict`. Pre-release versions are
58-
opt-in (unless you're using `latest`), so `1.11.x` will not match a pre-release.
56+
To use a pre-release version such as `v1.11.0-rc.0`), specify the exact version
57+
(`v1.11.0-rc.0`) and set `version-type` to `strict`.
58+
Note that pre-release versions are opt-in by default.
59+
Patterns like `1.11.x` do not include pre-release versions unless `latest` is specified.
5960

6061
#### "Latest" versions
6162

62-
Set a tool's version to `latest` to retrieve the latest version of a given tool; this includes
63-
release candidates. If you want to exclude release candidates, but still target the latest "stable"
64-
release, use a range such as `> 0`.
65-
The latest version is (locally) calculated by the action based on the (retrieved) versions
66-
it knows (**note**: it is not the same as [GitHub considers it](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)
67-
and some repositories might propose).
63+
To retrieve the most recent available version of a tool, set the version to `latest`.
64+
This may include pre-release versions such as release candidates.
6865

69-
If in doubt do a test run and compare the obtained release with the one you were expecting to
70-
be the latest.
66+
If you want to target only the latest stable release and exclude pre-releases, use a
67+
version range like `> 0` instead.
68+
69+
Note that the `latest` version is determined locally by the action based on the versions it
70+
has retrieved. This may differ from how[GitHub defines "latest"](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository),
71+
and some repositories may present different interpretations.
72+
73+
If you're unsure, perform a test run and compare the resolved version against the version you
74+
expect to be considered the latest.
7175

7276
### Compatibility between Operating System and Erlang/OTP
7377

0 commit comments

Comments
 (0)