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

cloud: document resource k/v tag usage #35942

Merged
merged 4 commits into from
Nov 4, 2024

Conversation

brandonc
Copy link
Contributor

@brandonc brandonc commented Nov 1, 2024

Adds supplemental documentation for the usage of key/value tags as an alternative to list of key-only strings in the cloud block

Target Release

1.10.0

Draft CHANGELOG entry

NEW FEATURES

  • cloud: cloud block now allows map of strings to be used as workspace key/value tags

Copy link
Contributor

@ctrombley ctrombley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only minor comments here. Looking good ✨

@@ -95,9 +95,9 @@ Specifies metadata for matching workspaces in HCP Terraform. Terraform associate

| Attribute | Description | Data type |
| --- | --- | --- |
| `tags` | Specifies a list of flat single-value tags. Terraform associates the configuration with workspaces that have all matching flat single-value tags. New workspaces created from the working directory inherit the tags. This attribute does not support key-value tags. You cannot set this attribute and the `name` attribute in the same configuration. | Array of strings |
| `tags` | Specifies either a map of strings as key/value tags or a list of single-value, key-only tags. Terraform associates the configuration with workspaces that have all matching tags. New workspaces created from the working directory inherit the tags. You cannot set this attribute and the `name` attribute in the same configuration. Using a map type with both keys and values requires Terraform 1.10+ | Array of strings or Map of strings |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: add period after Terraform 1.10+

layer = "networking"
source = "cli"
}
# For terraform versions below 1.10, you must specify key-only tags
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: consider a newline above the comment so the sections are not squished together

@brandonc brandonc added the 1.10-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged label Nov 4, 2024
@brandonc brandonc merged commit f0b00c4 into main Nov 4, 2024
11 checks passed
@brandonc brandonc deleted the TF-21933-document-cloud-block-tags-behavior-in-1-10 branch November 4, 2024 17:26
Copy link

github-actions bot commented Nov 4, 2024

Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.10-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants