Skip to content

Commit

Permalink
docs: add cross reference for default constraint (#136)
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Peabody <andrewpeabody@google.com>
  • Loading branch information
apeabody committed May 18, 2024
1 parent 53f420d commit d7b46d6
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1169,7 +1169,7 @@ Recognize same values as `tenv atmos use` command.
<a id="required_version"></a>
<details><summary><b>required_version</b></summary><br>

the `latest-allowed` or `min-required` strategies scan through your IAC files (.tf or .tf.json) and identify a version conforming to the constraint in the relevant files. They fallback to `latest` when no IAC files and no default constraint are found.
the `latest-allowed` or `min-required` strategies scan through your IAC files (.tf or .tf.json) and identify a version conforming to the constraint in the relevant files. They fallback to `latest` when no IAC files and no default constraint are found, and can optionally be used with a default constraint as detailed in <a href="#project-binaries">project binaries</a>.

Currently the format for [Terraform required_version](https://developer.hashicorp.com/terraform/language/settings#specifying-a-required-terraform-version) and [OpenTofu required_version](https://opentofu.org/docs/language/settings#specifying-a-required-opentofu-version) are very similar, however this may change over time, always refer to docs for the latest format specification.

Expand All @@ -1186,6 +1186,7 @@ This would identify the latest version at or above 1.2.0 and below 2.0.0
<a id="technical-details"></a>
## Technical details

<a id="project-binaries"></a>
### Project binaries

<details><summary><b>tofu</b></summary><br>
Expand Down

0 comments on commit d7b46d6

Please sign in to comment.