Show latest not working on .toml and README needs to be updated #252

warrensbox · 2022-06-20T03:48:28Z

Context

The documentation on the website and README is not up-to-date.
The show latest feature was not working for users using the .toml file

Fixed

Update the switch statement for .toml users
Update documentation on the website and README

Upgrade

N/A

Added

N/A

Removed

N/A

Fixes:

#249

yermulnik

My comments to README apply to Quick-Start.md.
I feel like main.go should not have hardcoded values for outputs of -S and -s, but rather have constraints mentioned the same way you PR'ed to README.

yermulnik · 2022-06-20T10:28:58Z

README.md

@@ -85,24 +85,24 @@ tfswitch #will automatically switch to terraform version 0.14.4
 3. Hit **Enter** to install.
 ### Install latest implicit version for stable releases
 1. Install the latest implicit stable version.
-2. Ex: `tfswitch -s 0.13` or `tfswitch --latest-stable 0.13` downloads 0.13.6 (latest) version.
+2. Ex: `tfswitch -s 0.13` or `tfswitch --latest-stable 0.13` downloads <1.1.0, >=1.0.0, 1.0 downloads <2.0.0, >=1.0.0.


I had to re-read several times to make myself sure I get the things, hence the suggestion from regular user's standpoint:

Suggested change

2. Ex: `tfswitch -s 0.13` or `tfswitch --latest-stable 0.13` downloads <1.1.0, >=1.0.0, 1.0 downloads <2.0.0, >=1.0.0.

2. Ex: `tfswitch -s 0.13` or `tfswitch --latest-stable 0.13` downloads `>=1.0.0, <1.1.0`, and `tfswitch -s 1.0` or `tfswitch --latest-stable 1.0` downloads `>=1.0.0, <2.0.0`.

Also would it worth to mention the logic is the same as what pessimistic constraint operator does in TF version constraint?
https://www.terraform.io/language/expressions/version-constraints#-3

I will try to reword it

yermulnik · 2022-06-20T10:31:36Z

README.md

 3. Hit **Enter** to install.
 ### Install latest implicit version for beta, alpha and release candidates(rc)
 1. Install the latest implicit pre-release version.
-2. Ex: `tfswitch -p 0.13` or `tfswitch --latest-pre 0.13` downloads 0.13.0-rc1 (latest) version.
+2. Ex: `tfswitch -p 0.13` or `tfswitch --latest-pre 0.13` downloads 0.13.0-rc1.


This is a bit confusing that -p works differently than e.g. -s. Though this flag's audience assumably is quite small to rework the logic 🤔

Yeah, -p only works for major.minor while -s works for major.minor.patch.

At that time, I do not know modify the regex to work with 0.0.X with X being 0-rc1 (alphanumeral+dash).

I am open to modifications, if anyone can make it better.

yermulnik · 2022-06-20T10:33:31Z

README.md

 ### Show latest implicit version for stable releases
 1. Show the latest implicit stable version.
-2. Ex: `tfswitch -S 0.13` or `tfswitch --show-latest-stable 0.13` shows 0.13.6 (latest) version.
-3. Hit **Enter** to show.
+2. Ex: `tfswitch -S 0.13` or `tfswitch --show-latest-stable 0.13` prints 0.15.5


I'm sure they won't release any more version lower than 1.0, but just to stay on safe side:

Suggested change

2. Ex: `tfswitch -S 0.13` or `tfswitch --show-latest-stable 0.13` prints 0.15.5

2. Ex: `tfswitch -S 0.13` or `tfswitch --show-latest-stable 0.13` prints 0.15.5 (latest version which falls under `>=1.0.0, <1.1.0` constraint as of June, 2022)

yermulnik · 2022-06-20T10:37:24Z

README.md

 ### Show latest implicit version for beta, alpha and release candidates(rc)
 1. Show the latest implicit pre-release version.
-2. Ex: `tfswitch -P 0.13` or `tfswitch --show-latest-pre 0.13` shows 0.13.0-rc1 (latest) version.
-3. Hit **Enter** to show.
+2. Ex: `tfswitch -P 0.13` or `tfswitch --show-latest-pre 0.13` prints 0.13.0-rc1.


This is a bit confusing that -P works differently than e.g. -S. Though this flag's audience assumably is quite small to rework the logic 🤔

warrensbox · 2024-04-25T08:34:33Z

I will look at this for release v1.12.
I am not sure, if it's still relevant

MatthewJohn · 2024-05-02T05:32:11Z

main.go

-	showLatestPre := getopt.StringLong("show-latest-pre", 'P', defaultLatest, "Show latest pre-release implicit version. Ex: tfswitch --show-latest-pre 0.13 prints 0.13.0-rc1 (latest)")
-	latestStable := getopt.StringLong("latest-stable", 's', defaultLatest, "Latest implicit version based on a constraint. Ex: tfswitch --latest-stable 0.13.0 downloads 0.13.7 and 0.13 downloads 0.15.5 (latest)")
-	showLatestStable := getopt.StringLong("show-latest-stable", 'S', defaultLatest, "Show latest implicit version. Ex: tfswitch --show-latest-stable 0.13 prints 0.13.7 (latest)")
+	latestPre := getopt.StringLong("latest-pre", 'p', defaultLatest, "Latest pre-release implicit version. Ex: tfswitch --latest-pre 0.13 downloads 0.13.0-rc1")


Is it worth quoting the command here to provide visible separation between the command and the expected result?
e.g.

latestPre := getopt.StringLong("latest-pre", 'p', defaultLatest, "Latest pre-release implicit version. Ex: `tfswitch --latest-pre 0.13` - downloads 0.13.0-rc1")

+1
Though I'd suggest to use double quotes instead of backticks as a more common thing in descriptions I guess.

MatthewJohn · 2024-05-02T05:36:16Z

main.go

@@ -102,21 +102,29 @@ func main() {

 		switch {
 		/* GIVEN A TOML FILE, */
-		/* show all terraform version including betas and RCs*/
+		/* show all terraform version including betas and RCs */
 		case *listAllFlag:


I'm trying to work out why this case switch logic is duplicated for the TOML file.
Can the TOML file detection not be done before the switch case and just update the variables for version/binPath and then run the single case switch?

Though, I'm happy to take a look at trying to simplify this outside of this PR, if you agree?

Ah, just realised the PR was started 2 years ago 😅

warrensbox · 2024-05-06T07:57:14Z

@yermulnik is this still relevant or can we close this?

yermulnik · 2024-05-06T12:31:14Z

@yermulnik is this still relevant or can we close this?

Not sure this is still relevant (even if the "issue" is till there) as it's been a while. I'd suggest we close it and re-open via another issue if this is still relevant.

warrensbox added 4 commits June 15, 2022 15:05

Fix documentation and added show stable for toml file users

b5ca32e

Updated documentation

ea34dc2

Update readme and quick start

40fa8f7

Update readme and website

b3f55b8

warrensbox requested review from jukie and yermulnik June 20, 2022 03:49

warrensbox changed the title ~~Fix/bug document show latest~~ Show latest not working on .toml and README needs to be updated Jun 20, 2022

warrensbox mentioned this pull request Jun 20, 2022

adjust regex to get all terraform versinos from mirror #251

Merged

yermulnik reviewed Jun 20, 2022

View reviewed changes

make env variable last in Order of precedence

0833c9a

MatthewJohn reviewed May 2, 2024

View reviewed changes

yermulnik added documentation Add or improve documentation: README/CHANGELOG/comments on code enhancement Refactor existing code for better performance and quality labels Jul 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show latest not working on .toml and README needs to be updated #252

Show latest not working on .toml and README needs to be updated #252

warrensbox commented Jun 20, 2022

yermulnik left a comment

yermulnik Jun 20, 2022

warrensbox Jun 20, 2022

yermulnik Jun 20, 2022

warrensbox Jun 20, 2022

yermulnik Jun 20, 2022

yermulnik Jun 20, 2022

warrensbox commented Apr 25, 2024

MatthewJohn May 2, 2024

yermulnik May 2, 2024

MatthewJohn May 2, 2024

MatthewJohn May 2, 2024

MatthewJohn May 2, 2024

warrensbox commented May 6, 2024

yermulnik commented May 6, 2024

	2. Ex: `tfswitch -s 0.13` or `tfswitch --latest-stable 0.13` downloads <1.1.0, >=1.0.0, 1.0 downloads <2.0.0, >=1.0.0.
	2. Ex: `tfswitch -s 0.13` or `tfswitch --latest-stable 0.13` downloads `>=1.0.0, <1.1.0`, and `tfswitch -s 1.0` or `tfswitch --latest-stable 1.0` downloads `>=1.0.0, <2.0.0`.

Show latest not working on .toml and README needs to be updated #252

Are you sure you want to change the base?

Show latest not working on .toml and README needs to be updated #252

Conversation

warrensbox commented Jun 20, 2022

Context

Fixed

Upgrade

Added

Removed

Fixes:

yermulnik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

warrensbox commented Apr 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

warrensbox commented May 6, 2024

yermulnik commented May 6, 2024