Skip to content

docs: Warn about use of heredoc for JSON/YAML #37084

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 19, 2025
Merged

docs: Warn about use of heredoc for JSON/YAML #37084

merged 2 commits into from
May 19, 2025

Conversation

radeksimko
Copy link
Member

@radeksimko radeksimko commented May 19, 2025 •
edited
Loading

Closes #35029

Preview

https://terraform-et2f4hct7-hashicorp.vercel.app/terraform/language/expressions/strings#heredoc-strings
Screenshot 2025-05-19 at 11 28 27

Target Release

1.13.x

Rollback Plan

  • If a change needs to be reverted, we will roll out an update to the code within 7 days.

Changes to Security Controls

Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.

CHANGELOG entry

  • This change is user-facing and I added a changelog entry.
  • This change is not user-facing.

@radeksimko radeksimko added documentation no-changelog-needed Add this to your PR if the change does not require a changelog entry labels May 19, 2025
@radeksimko radeksimko force-pushed the docs/warn-heredoc-json-yaml branch from 7715ac3 to f0e16b5 Compare May 19, 2025 09:40
@radeksimko radeksimko force-pushed the docs/warn-heredoc-json-yaml branch from f0e16b5 to 7ef7098 Compare May 19, 2025 10:04
@radeksimko radeksimko force-pushed the docs/warn-heredoc-json-yaml branch from 7ef7098 to fc387b4 Compare May 19, 2025 10:14
@radeksimko radeksimko force-pushed the docs/warn-heredoc-json-yaml branch from fc387b4 to 1ff1106 Compare May 19, 2025 10:21
@radeksimko radeksimko force-pushed the docs/warn-heredoc-json-yaml branch from 1ff1106 to 21947d2 Compare May 19, 2025 10:28
@radeksimko radeksimko added 1.8-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.9-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.10-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.11-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.12-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged labels May 19, 2025
@radeksimko radeksimko force-pushed the docs/warn-heredoc-json-yaml branch from 21947d2 to 671e8c0 Compare May 19, 2025 10:36
@radeksimko radeksimko marked this pull request as ready for review May 19, 2025 10:47
@radeksimko radeksimko requested review from a team as code owners May 19, 2025 10:47
dbanck
dbanck previously approved these changes May 19, 2025
View reviewed changes
Copy link
Member

@dbanck dbanck left a comment

Choose a reason for hiding this comment

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

Great idea to use the highlight block!

Small nit: The position of the highlight box immediately after the headline doesn't feel right. I think it would make more sense at the end of the first section (line 94), so you can learn about Heredoc first

@radeksimko
Copy link
Member Author

@dbanck 👍🏻 moved the block, PTAL

@radeksimko radeksimko requested a review from dbanck May 19, 2025 11:32
@radeksimko radeksimko merged commit 3ab58cd into main May 19, 2025
9 checks passed
@radeksimko radeksimko deleted the docs/warn-heredoc-json-yaml branch May 19, 2025 12:57
This was referenced May 19, 2025
Merged
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dbanck dbanck dbanck approved these changes

Assignees
No one assigned
Labels
1.8-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.9-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.10-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.11-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged 1.12-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged documentation no-changelog-needed Add this to your PR if the change does not require a changelog entry
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@radeksimko @dbanck
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy