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

DXCDT-244: Escape dollar sign references in prompts docs #366

Merged
merged 8 commits into from
Oct 17, 2022

Conversation

willvedd
Copy link
Contributor

@willvedd willvedd commented Oct 14, 2022

🔧 Changes

As pointed out by #332 , the custom text prompts documentation references unescaped dollar signs in the example. When Terraform plan'ing the literal example, an error similar to the following will be incurred:

│ Error: Invalid reference
│ 
│   on main.tf line 21, in resource "auth0_prompt_custom_text" "example":
│   21:         "federatedConnectionButtonText" : "Continue with ${connectionName}",
│ 
│ A reference to a resource type must be followed by at least one attribute access, specifying the resource name.

This PR simply corrects the documentation by escaping the dollar signs with another prepended dollar sign.

📚 References

Original issue: #332

Similar Stackoverflow issue: https://stackoverflow.com/questions/66953938/escaping-dollar-sign-in-terraform

🔬 Testing

Added custom text variable replacement to custom text tests. Also manually tested the example snippet.

📝 Checklist

  • All new/changed/fixed functionality is covered by tests (or N/A)
  • I have added documentation for all new/changed functionality (or N/A)

@willvedd willvedd requested a review from a team as a code owner October 14, 2022 10:43
@codecov-commenter
Copy link

codecov-commenter commented Oct 14, 2022

Codecov Report

Base: 86.81% // Head: 86.81% // No change to project coverage 👍

Coverage data is based on head (9a85b07) compared to base (de4a0d8).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #366   +/-   ##
=======================================
  Coverage   86.81%   86.81%           
=======================================
  Files          40       40           
  Lines        8527     8527           
=======================================
  Hits         7403     7403           
  Misses        863      863           
  Partials      261      261           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@sergiught sergiught changed the title Escape dollar sign references in prompts docs DXCDT-244: Escape dollar sign references in prompts docs Oct 14, 2022
@sergiught sergiught merged commit 297a31b into main Oct 17, 2022
@sergiught sergiught deleted the gh-332-escape-dolllar-sign-docs branch October 17, 2022 07:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants