[TFDN-182] TFE ToolVersion API Doc Updates for ARM Support #547
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Vercel Previews Deployed
|
Broken Link CheckerNo broken links found! 🎉 |
natalie-todd
force-pushed
the
kelsi-hoyle/TFDN-182/arm-support-updates
branch
from
46114ec to
9384b3b
Compare
natalie-todd
approved these changes
Jul 11, 2025
There was a problem hiding this comment.
I made some suggestions and linked to the style guide for my rationale. But just to sum up, I don't believe we have a concept of a "pre-deprecation" cycle, so until something is actually deprecated, I think the most we can say is that something is under review. "Deprecated soon" is too much of a hedge.
| | `data.attributes.deprecated-reason` | string | (previous value) | Additional context about why a version of Sentinel is deprecated. | | ||
| | `data.attributes.enabled` | bool | (previous value) | Whether or not this version of Sentinel is enabled for use in HCP Terraform. | | ||
| | `data.attributes.beta` | bool | (previous value) | Whether or not this version of Sentinel is a beta pre-release. | | ||
| ~> **Note:** The `archs[n].url` and `archs[n].sha` fields are the recommended way to set the URL and SHA-256 checksum of a Sentinel binary. The `url` and `sha` fields are in the process of being deprecated but can still be used to set Linux amd64 URL and SHA-256 checksums. |
There was a problem hiding this comment.
Suggested change
| ~> **Note:** The `archs[n].url` and `archs[n].sha` fields are the recommended way to set the URL and SHA-256 checksum of a Sentinel binary. The `url` and `sha` fields are in the process of being deprecated but can still be used to set Linux amd64 URL and SHA-256 checksums. | |
| We recommend setting the URL and SHA-256 checksum of a Sentinel binary in the `archs[n].url` and `archs[n].sha` fields. |
Per the style guide, we should describe the product as it currently exists.
| | ----------------------------------- | ------ | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `data.type` | string | | Must be `"sentinel-versions"`. | | ||
| | `data.attributes.version` | string | (previous value) | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). | | ||
| | `data.attributes.url` | string | (previous value) | **Soon to be deprecated.** The URL where you can download the Linux amd64 binary of this version. | |
There was a problem hiding this comment.
Suggested change
| | `data.attributes.url` | string | (previous value) | **Soon to be deprecated.** The URL where you can download the Linux amd64 binary of this version. | | |
| | `data.attributes.url` | string | (previous value) | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. | |
This suggestion is also related to the style guidance about describing the product as is. We also have a rule about emphasis
| | `data.type` | string | | Must be `"sentinel-versions"`. | | ||
| | `data.attributes.version` | string | (previous value) | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). | | ||
| | `data.attributes.url` | string | (previous value) | **Soon to be deprecated.** The URL where you can download the Linux amd64 binary of this version. | | ||
| | `data.attributes.sha` | string | (previous value) | **Soon to be deprecated.** The SHA-256 checksum of the Linux amd64 Sentinel binary. | |
There was a problem hiding this comment.
Suggested change
| | `data.attributes.sha` | string | (previous value) | **Soon to be deprecated.** The SHA-256 checksum of the Linux amd64 Sentinel binary. | | |
| | `data.attributes.sha` | string | (previous value) | The SHA-256 checksum of the Linux amd64 Sentinel binary. This field is under review. We recommend using the `archs[n].sha` field instead. | |
Comment on lines
+337
to
+338
| | `data.attributes.archs[n].url` | string | | **Recommended field to set url.** The URL where you can download the 64-bit Linux binary of this version. | | ||
| | `data.attributes.archs[n].sha` | string | | **Recommended field to set sha.** The SHA-256 checksum of the Sentinel binary. | |
There was a problem hiding this comment.
Suggested change
| | `data.attributes.archs[n].url` | string | | **Recommended field to set url.** The URL where you can download the 64-bit Linux binary of this version. | | |
| | `data.attributes.archs[n].sha` | string | | **Recommended field to set sha.** The SHA-256 checksum of the Sentinel binary. | | |
| | `data.attributes.archs[n].url` | string | | The URL where you can download the 64-bit Linux binary of this version. We recommend using this field to set the URL instead of the `url` field, which performs a similar function. | | |
| | `data.attributes.archs[n].sha` | string | | The SHA-256 checksum of the Sentinel binary. We recommend using this field to set the checksum instead of `sha`, which performs a similar function. | |
We can also drop the ", which performs a similar function" part.
| | `data.attributes.official` | bool | `false` | Whether or not this is an official release of Terraform | | ||
| | `data.attributes.enabled` | bool | `true` | Whether or not this version of Terraform is enabled for use in HCP Terraform | | ||
| | `data.attributes.beta` | bool | `false` | Whether or not this version of Terraform is a beta pre-release | | ||
| ~> **Note:** The `archs[n].url` and `archs[n].sha` fields are the recommended way to set the URL and SHA-256 checksum of a Terraform binary. The `url` and `sha` fields are in the process of being deprecated but can still be used to set Linux amd64 URL and SHA-256 checksums. |
There was a problem hiding this comment.
Suggested change
| ~> **Note:** The `archs[n].url` and `archs[n].sha` fields are the recommended way to set the URL and SHA-256 checksum of a Terraform binary. The `url` and `sha` fields are in the process of being deprecated but can still be used to set Linux amd64 URL and SHA-256 checksums. | |
| We recommend setting the URL and SHA-256 checksum of a Terraform binary in the `archs[n].url` and `archs[n].sha` fields. |
Comment on lines
+168
to
+169
| | `data.attributes.url` | string | | **Soon to be deprecated.** The URL where you can download the Linux amd64 binary of this version. | | ||
| | `data.attributes.sha` | string | | **Soon to be deprecated.** The SHA-256 checksum of the Linux amd64 Terraform binary. | |
There was a problem hiding this comment.
Suggested change
| | `data.attributes.url` | string | | **Soon to be deprecated.** The URL where you can download the Linux amd64 binary of this version. | | |
| | `data.attributes.sha` | string | | **Soon to be deprecated.** The SHA-256 checksum of the Linux amd64 Terraform binary. | | |
| | `data.attributes.url` | string | | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. | | |
| | `data.attributes.sha` | string | | The SHA-256 checksum of the Linux amd64 Terraform binary. This field is under review. We recommend using the `archs[n].sha` field instead. | |
Comment on lines
+176
to
+177
| | `data.attributes.archs[n].url` | string | | **Recommended field to set url.** The URL where you can download the 64-bit Linux binary of this version. | | ||
| | `data.attributes.archs[n].sha` | string | | **Recommended field to set sha.** The SHA-256 checksum of the Terraform binary. | |
There was a problem hiding this comment.
Suggested change
| | `data.attributes.archs[n].url` | string | | **Recommended field to set url.** The URL where you can download the 64-bit Linux binary of this version. | | |
| | `data.attributes.archs[n].sha` | string | | **Recommended field to set sha.** The SHA-256 checksum of the Terraform binary. | | |
| | `data.attributes.archs[n].url` | string | | The URL where you can download the 64-bit Linux binary of this version. We recommend using this field to set the URL instead of the `url` field, which performs a similar function. | | |
| | `data.attributes.archs[n].sha` | string | | The SHA-256 checksum of the Terraform binary. We recommend using this field to set the checksum instead of the `sha` field, which performs a similar function. | |
| | `data.attributes.deprecated-reason` | string | (previous value) | Additional context about why a version of Terraform is deprecated. | | ||
| | `data.attributes.enabled` | bool | (previous value) | Whether or not this version of Terraform is enabled for use in HCP Terraform | | ||
| | `data.attributes.beta` | bool | (previous value) | Whether or not this version of Terraform is a beta pre-release | | ||
| ~> **Note:** The `archs[n].url` and `archs[n].sha` fields are the recommended way to set the URL and SHA-256 checksum of a Terraform binary. The `url` and `sha` fields are in the process of being deprecated but can still be used to set Linux amd64 URL and SHA-256 checksums. |
There was a problem hiding this comment.
Suggested change
| ~> **Note:** The `archs[n].url` and `archs[n].sha` fields are the recommended way to set the URL and SHA-256 checksum of a Terraform binary. The `url` and `sha` fields are in the process of being deprecated but can still be used to set Linux amd64 URL and SHA-256 checksums. | |
| We recommend setting the URL and SHA-256 checksum of a Terraform binary in the `archs[n].url` and `archs[n].sha` fields. |
Comment on lines
+344
to
+345
| | `data.attributes.url` | string | (previous value) | **Soon to be deprecated.** The URL where you can download the Linux amd64 binary of this version. | | ||
| | `data.attributes.sha` | string | (previous value) | **Soon to be deprecated.** The SHA-256 checksum of the Linux amd64 Terraform binary. | |
There was a problem hiding this comment.
Suggested change
| | `data.attributes.url` | string | (previous value) | **Soon to be deprecated.** The URL where you can download the Linux amd64 binary of this version. | | |
| | `data.attributes.sha` | string | (previous value) | **Soon to be deprecated.** The SHA-256 checksum of the Linux amd64 Terraform binary. | | |
| | `data.attributes.url` | string | (previous value) | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. | | |
| | `data.attributes.sha` | string | (previous value) | The SHA-256 checksum of the Linux amd64 Terraform binary. This field is under review. We recommend using the `archs[n].sha` field instead. | |
Comment on lines
+352
to
+353
| | `data.attributes.archs[n].url` | string | | **Recommended field to set url.** The URL where you can download the 64-bit Linux binary of this version. | | ||
| | `data.attributes.archs[n].sha` | string | | **Recommended field to set sha.** The SHA-256 checksum of the Terraform binary. | |
There was a problem hiding this comment.
Suggested change
| | `data.attributes.archs[n].url` | string | | **Recommended field to set url.** The URL where you can download the 64-bit Linux binary of this version. | | |
| | `data.attributes.archs[n].sha` | string | | **Recommended field to set sha.** The SHA-256 checksum of the Terraform binary. | | |
| | `data.attributes.archs[n].url` | string | | The URL where you can download the 64-bit Linux binary of this version. We recommend using this field to set the URL instead of the `url` field, which performs a similar function. | | |
| | `data.attributes.archs[n].sha` | string | | The SHA-256 checksum of the Terraform binary. We recommend using this field to set the checksum instead of the `sha` field, which performs a similar function. | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the tool version API docs to reflect the addition of the
archsfield and the recommendation ofarch[n].urlandarch[n].shausage over the soon to be deprecated fields,urlandsha.Jira
RFC