Skip to content

Replace hyphens with underscores in environment variable names #35923

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 1 commit into from
Nov 13, 2024
Merged

Replace hyphens with underscores in environment variable names #35923

merged 1 commit into from
Nov 13, 2024

Conversation

yilas
Copy link
Contributor

@yilas yilas commented Nov 12, 2024 •
edited by qmonnet
Loading

In bash, hyphens are not permitted in variable names, as they can cause syntax errors. To avoid this issue, variable names have been updated to use underscores (_) instead of hyphens. This change ensures compatibility with bash syntax and avoids potential errors during script execution.

Please ensure your pull request adheres to the following guidelines:

  • For first time contributors, read Submitting a pull request
  • All code is covered by unit and/or runtime tests where feasible.
  • All commits contain a well written commit description including a title,
    description and a Fixes: #XXX line if the commit addresses a particular
    GitHub issue.
  • If your commit description contains a Fixes: <commit-id> tag, then
    please add the commit author[s] as reviewer[s] to this issue.
  • All commits are signed off. See the section Developer’s Certificate of Origin
  • Provide a title or release-note blurb suitable for the release notes.
  • Are you a user of Cilium? Please add yourself to the Users doc
  • Thanks for contributing!
docs: In k0s guide, remove dashes to fix invalid Bash variable names.

Fixes: #35922

@yilas yilas requested a review from a team as a code owner November 12, 2024 14:06
@yilas yilas requested a review from qmonnet November 12, 2024 14:06
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Nov 12, 2024
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label Nov 12, 2024
qmonnet
qmonnet requested changes Nov 12, 2024
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Thanks! Please fix the missing bracket (see below). You also have a typo in your commit log (corrects -> correct).

@qmonnet qmonnet added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. labels Nov 12, 2024
@maintainer-s-little-helper maintainer-s-little-helper bot removed dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Nov 12, 2024
@qmonnet qmonnet added needs-backport/1.14 needs-backport/1.16 This PR / issue needs backporting to the v1.16 branch labels Nov 12, 2024
yilas

This comment was marked as duplicate.

Sign in to view

@qmonnet
Copy link
Member

qmonnet commented Nov 12, 2024

Thank you! Can you please squash the two commits together and force-push?

@maintainer-s-little-helper
Copy link

Commit 930ebd4 does not match "(?m)^Signed-off-by:".

Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin

@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. label Nov 12, 2024
@yilas
Copy link
Contributor Author

yilas commented Nov 12, 2024

Thank you! Can you please squash the two commits together and force-push?

Thank you ! Commits have been squashed and force-pushed as requested.

@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. label Nov 12, 2024
@qmonnet
Copy link
Member

qmonnet commented Nov 12, 2024 •
edited
Loading

Thanks, change looks good. Can I just ask again to change your commit title? You're not removing underscore (you're adding them! 🙂) but dashes. Can you also please make the commit title fit under 80 characters? The checkpatch CI job will complain otherwise. You can add more context in the commit description (separated from the title by a blank line) if necessary.

@yilas
Replace dashes with underscores in environment variable names
7f10c62 
Signed-off-by: Yann ILAS <yann.ilas@gmail.com>
@yilas yilas changed the title Adjustment of Variable Naming to Remove Hyphens (node1_IP, node2_IP and node3_IP) Replace hyphens with underscores in environment variable names Nov 12, 2024
@yilas
Copy link
Contributor Author

yilas commented Nov 12, 2024

Oops, sorry... Where was my head ? I just made the change...

qmonnet
qmonnet approved these changes Nov 13, 2024
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

@qmonnet
Copy link
Member

qmonnet commented Nov 13, 2024

/test

@qmonnet qmonnet enabled auto-merge November 13, 2024 10:59
@qmonnet qmonnet added this pull request to the merge queue Nov 13, 2024
Merged via the queue into cilium:main with commit 5cbec4a Nov 13, 2024
58 of 59 checks passed
@maintainer-s-little-helper maintainer-s-little-helper bot added ready-to-merge This PR has passed all tests and received consensus from code owners to merge. labels Nov 13, 2024
@rastislavs rastislavs mentioned this pull request Nov 20, 2024
Merged
14 tasks
@rastislavs rastislavs added backport-pending/1.16 The backport for Cilium 1.16.x for this PR is in progress. and removed needs-backport/1.16 This PR / issue needs backporting to the v1.16 branch labels Nov 20, 2024
@rastislavs rastislavs mentioned this pull request Nov 20, 2024
Merged
6 tasks
@rastislavs rastislavs added backport-pending/1.15 The backport for Cilium 1.15.x for this PR is in progress. and removed needs-backport/1.15 labels Nov 20, 2024
@rastislavs rastislavs mentioned this pull request Nov 20, 2024
Merged
5 tasks
@rastislavs rastislavs added backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. and removed needs-backport/1.14 labels Nov 20, 2024
@github-actions github-actions bot added backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. backport-done/1.15 The backport for Cilium 1.15.x for this PR is done. backport-done/1.16 The backport for Cilium 1.16.x for this PR is done. and removed backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. backport-pending/1.15 The backport for Cilium 1.15.x for this PR is in progress. backport-pending/1.16 The backport for Cilium 1.16.x for this PR is in progress. labels Nov 21, 2024
This was referenced Dec 12, 2024
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@qmonnet qmonnet qmonnet approved these changes

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. backport-done/1.15 The backport for Cilium 1.15.x for this PR is done. backport-done/1.16 The backport for Cilium 1.16.x for this PR is done. kind/community-contribution This was a contribution made by a community member. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Doc k0s] Adjust variable naming convention to remove hyphens
3 participants
@yilas @qmonnet @rastislavs