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.

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

Document what happens when '.x' version is specified, such as '1.16.x' #115

Closed
x448 opened this issue Jun 15, 2021 · 7 comments
Closed

Document what happens when '.x' version is specified, such as '1.16.x' #115

x448 opened this issue Jun 15, 2021 · 7 comments
Labels
documentation Improvements or additions to documentation

Comments

@x448
Copy link

x448 commented Jun 15, 2021

README.md should explain differences (if any) between specifying "1.16" vs "1.16.x".

Even if go-version documents this in the future, it would be user-friendly to document it (at least briefly) in setup-go.

@codefromthecrypt
Copy link

if anyone knows what the difference is now, do tell!

@codefromthecrypt
Copy link

leaving out the patch version results in choosing the latest patch

Ex.

Setup go stable version spec 1.17
Found in cache @ C:\hostedtoolcache\windows\go\1.17.1\x64
Added go to the path
Successfully setup go version 1.17
go version go1.17.1 windows/amd64

@Sergey-Murtazin Sergey-Murtazin added the documentation Improvements or additions to documentation label Oct 21, 2021
@Sergey-Murtazin
Copy link
Contributor

Hi, @x448 !
As written in readme, we are using semver notation.
You can see how to use it here

The x sign means that the version with the maximum available version number in place of this sign will be used.
For example:

  • 1.7.x goes to 1.7.3 if 1.7.3 is the maximum 1.17 version
  • 1.x goes to 1.7.3 too if 1.7.3 is the maximum 1 version

@x448
Copy link
Author

x448 commented Dec 6, 2021

Hi @Sergey-Murtazin,

It's too easy for users to confuse 1.16 as "use default 1.16 installed" vs "download latest 1.16.x to replace default 1.16". Same confusion with 1.16.x. Adding a short example to docs would be a reasonable & easy solution.

New users to GitHub won't be able to just try both 1.15 and 1.15.x to clear up the ambiguity because the default is Go 1.15.15 on ubuntu-latest and there' no newer 1.15.x available. And specifying 1.16 or 1.16.x both grab 1.16.10 even though 1.16.11 has been available for 4 days.

Something like this clarification in the docs would be helpful to GitHub users:

Specifying 1.16 vs 1.16.x is [the same .../... different].

If the vm has 1.16.88 as the default Go 1.16 and 1.16.99 is available, then:
- 1.16 uses 1.16.__ because [it uses the default 1.16.88 already installed .../... downloads 1.16.99]
- 1.16.x uses 1.16.__ because [it uses the default 1.16.88 already installed .../... download 1.16.99]

@Sergey-Murtazin
Copy link
Contributor

Hi, @x448!

Thanks for your proposal!
Currently pull request in review.

@dmitry-shibanov
Copy link
Contributor

Hello everyone. I'm going to close this issue because we add a note about SemVer in scope of this pull request. Besides, we're going to add check latest logic in scope of this pull request.

@x448
Copy link
Author

x448 commented May 16, 2022

Thanks for adding check-version feature!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants