-
Notifications
You must be signed in to change notification settings - Fork 54
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
Use single underscore as separator in environment variables #1837
Merged
jarhodes314
merged 2 commits into
thin-edge:main
from
jarhodes314:feat/remove-underscores-from-env-vars
Mar 23, 2023
Merged
Use single underscore as separator in environment variables #1837
jarhodes314
merged 2 commits into
thin-edge:main
from
jarhodes314:feat/remove-underscores-from-env-vars
Mar 23, 2023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: James Rhodes <jarhodes314@gmail.com>
jarhodes314
temporarily deployed
to
Test Pull Request
March 22, 2023 18:00
— with
GitHub Actions
Inactive
Robot Results
Passed Tests
|
didier-wenzek
approved these changes
Mar 23, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved - with a minor comment.
Co-authored-by: Didier Wenzek <didier.wenzek@free.fr>
jarhodes314
temporarily deployed
to
Test Pull Request
March 23, 2023 09:13
— with
GitHub Actions
Inactive
reubenmiller
approved these changes
Mar 23, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great PR. That simplifies things for the user!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
This removes the need for a customer to use
__
(double underscore) as a separator when specifying the configuration as environment variables.Types of changes
Paste Link to the issue
#1835
Checklist
cargo fmt
as mentioned in CODING_GUIDELINEScargo clippy
as mentioned in CODING_GUIDELINESFurther comments
The very simple assumption used to determine how environment variables map to toml tables (i.e. the first underscore is converted to
.
, and every underscore after is preserved) means that completely unknown keys (as opposed to unknown keys in known tables, likec8y.unknown
/TEDGE_C8Y_UNKNOWN
) now produce less clear warnings.The warning we get is
Unknown configuration field "unknown" from `TEDGE_` environment variable(s)
This really ought to be more like:
Unknown configuration field "unknown_configuration" from environment variable TEDGE_UNKNOWN_CONFIGURATION
However this should be easy to address when fixing #1812 since part of that will involve deriving what keys are available from the configuration structs themselves. At that point, I intend to split the variables only when we recognise the configuration value.