Skip to content

Commit

Permalink
doc: Added latest-allowed-stable description to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vahid-haghighat committed Dec 1, 2024
1 parent 5b74364 commit bcabba3
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ If a parameter is passed, available options:
- `latest` is a syntax to install latest version
- `latest:<regex>` is a syntax to install latest version matching regex (used by grep -e)
- `latest-allowed` is a syntax to scan your Terraform files to detect which version is maximally allowed.
- `latest-allowed-stable` is the same as `latest-allowed`, but only considers stable versions and not pre-releases.
- `min-required` is a syntax to scan your Terraform files to detect which version is minimally required.

See [required_version](https://developer.hashicorp.com/terraform/language/settings) docs. Also [see min-required & latest-allowed](#min-required) section below.
Expand All @@ -104,6 +105,7 @@ $ tfenv install 0.7.0
$ tfenv install latest
$ tfenv install latest:^0.8
$ tfenv install latest-allowed
$ tfenv install latest-allowed-stable
$ tfenv install min-required
```

Expand Down Expand Up @@ -131,7 +133,7 @@ validation failure.
If you use a [.terraform-version](#terraform-version-file) file, `tfenv install` (no argument) will install the version written in it.

<a name="min-required"></a>
#### min-required & latest-allowed
#### min-required & latest-allowed & latest-allowed-stable

Please note that we don't do semantic version range parsing but use first ever found version as the candidate for minimally required one. It is up to the user to keep the definition reasonable. I.e.

Expand Down

0 comments on commit bcabba3

Please sign in to comment.