Skip to content

fix: Make usage of quotes for templating consistent #22605

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

raweber42
Copy link
Contributor

Checklist:

  • [c] Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

I got confused with the usage of single and double quotes. I don't think there is any significance in using double quotes around the .values templating value, is there? In line 237, single quotes are being used, too. So I guess this would be good for consistency. In general: I am wondering: When do we use single/double quotes? I didn't find any difference in how ArgoCD expands variables etc within single vs double quotes.

@raweber42 raweber42 requested review from a team as code owners April 8, 2025 08:35
Copy link

bunnyshell bot commented Apr 8, 2025

🔴 Preview Environment stopped on Bunnyshell

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

  • 🔵 /bns:start to start the environment
  • 🚀 /bns:deploy to redeploy the environment
  • /bns:delete to remove the environment

@crenshaw-dev
Copy link
Member

The user only needs to make sure that the field is a YAML string. Beyond that, Argo has no opinion on (or knowledge of) the string delimitation.

@raweber42
Copy link
Contributor Author

@crenshaw-dev alright, thank you!

But then I think it would be wise to consistently use single or double quotes across the argocd documentation to reduce room for speculation (like for me).

If you approve of this, I am happy to create an extensive PR to update the usage examples across the ArgoCD docs.

@crenshaw-dev
Copy link
Member

I don't feel strongly either way 🙂

@@ -372,7 +372,7 @@ spec:
source:
repoURL: https://github.com/argoproj/argo-cd.git
targetRevision: HEAD
path: "{{.values.base_dir}}/apps/guestbook"
path: '{{.values.base_dir}}/apps/guestbook'
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
path: '{{.values.base_dir}}/apps/guestbook'
path: '{{.values.base_dir}}/apps/guestbook'

I personally think it isn't necessary. If we change it to single dash, this gives the user a perspective that only single dash could be used (unless they try double dash too). Having both sort of examples makes sense. Although you're correct about consistency around docs but I don't think it's such a big change that needs to be consistent across all docs. Having said that, I'm proposing to revert the changes.

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.

3 participants