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

Backport of docs: Replace unicode quotes with ASCII quotes into release/1.14.x #18970

Conversation

hc-github-team-consul-core
Copy link
Contributor

Backport

This PR is auto-generated from #18950 to be assessed for backporting due to the inclusion of the label backport/1.14.

🚨

Warning automatic cherry-pick of commits failed. If the first commit failed,
you will see a blank no-op commit below. If at least one commit succeeded, you
will see the cherry-picked commits up to, not including, the commit where
the merge conflict occurred.

The person who merged in the original PR is:
@blake
This person should manually cherry-pick the original PR into a new backport PR,
and close this one when the manual backport PR is merged in.

merge conflict error: POST https://api.github.com/repos/hashicorp/consul/merges: 409 Merge conflict []

The below text is copied from the body of the original PR.


Description

Replaces unicode quotation marks with ASCII quotation marks.

For code examples, this fixes HCL decoding errors that would otherwise be raised when attempting to read the file.

Testing & Reproduction steps

  1. Create a configuration entry that contains unicode quotation marks.

    # proxy-defaults-with-unicode-quotes.hcl
    Kind = “proxy-defaults”
    Name = "global"
    Config = {
      envoy_dogstatsd_url = "udp://127.0.0.1:8125"
    }
  2. Attempt to save the configuration entry.

    $ consul config write proxy-defaults-with-unicode-quotes.hcl
    Failed to decode config entry input: Failed to decode config entry input: At 1:15: illegal char
    

The config entry fails to be decoded due to the unsupported unicode character.

Below is the behavior with the unicode quotes removed.

  1. Create a configuration entry with only ASCII quotation marks.

    # proxy-defaults-with-ascii-quotes.hcl
    Kind = "proxy-defaults"
    Name = "global"
    Config = {
      envoy_dogstatsd_url = "udp://127.0.0.1:8125"
    }
  2. Attempt to write the configuration entry.

    $ consul config write proxy-defaults-with-ascii-quotes.hcl                                                                                         
    Config entry written: proxy-defaults/global
    

PR Checklist

  • updated test coverage
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

Overview of commits

@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/docs/replace-unicode-quotes-with-ascii/similarly-divine-snapper branch from c168861 to 392a8d8 Compare September 21, 2023 22:17
@hashicorp-cla
Copy link

hashicorp-cla commented Sep 21, 2023

CLA assistant check
All committers have signed the CLA.

Copy link

Choose a reason for hiding this comment

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

Auto approved Consul Bot automated PR

@vercel vercel bot temporarily deployed to Preview – consul September 21, 2023 22:28 Inactive
@blake blake force-pushed the backport/docs/replace-unicode-quotes-with-ascii/similarly-divine-snapper branch from 8d03c71 to bf38399 Compare September 21, 2023 23:00
@blake blake marked this pull request as ready for review September 21, 2023 23:01
@blake blake requested a review from a team as a code owner September 21, 2023 23:01
@blake blake enabled auto-merge (squash) September 21, 2023 23:02
@blake blake merged commit 14d82b8 into release/1.14.x Sep 21, 2023
88 checks passed
@blake blake deleted the backport/docs/replace-unicode-quotes-with-ascii/similarly-divine-snapper branch September 21, 2023 23:11
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