-
Notifications
You must be signed in to change notification settings - Fork 159
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
envsubst: remove explicit subst of exported vars #830
Open
alxndrsn
wants to merge
5
commits into
getodk:next
Choose a base branch
from
alxndrsn:envsbust-awk
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
For nginx config, a new approach is implemented with mawk. This is similar to envusbst, but more ergonomic: * no need to explicitly list all variables * throw error on missing variables * do not replace nginx vars like $host, $request_uri with empty strings (in contrast to envsubst when executed without an explicit variable list) Risks: There are a couple of changes which may break existing deployments: * changing client-config.json.template * requiring all substituted variable to be defined Closes getodk#473
2 tasks
brontolosone
requested changes
Dec 9, 2024
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.
Splendid!
brontolosone
approved these changes
Dec 10, 2024
This should get 1 more review, and then merged after the last 2024 release goes out. |
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.
Approach suggested in #818 (comment)
For nginx config, a new approach is implemented with mawk.
This is similar to envsubst, but more ergonomic:
Risks:
There are a couple of changes which may break existing deployments:
Closes #473
What has been done to verify that this works as intended?
Added tests, added tests to CI, run tests.
Why is this the best possible solution? Were any other approaches considered?
Considered perl, bash & sed, as they are other scripting languages present in the images in which we currently use
enbsubst
. awk or perl seem the most suitable. I am not aware of a reason to use one over the other.How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?
As mentioned above, there's a risk that throwing when a variable is not defined will break existing deployments. That wouldn't be great.
Does this change require updates to documentation? If so, please file an issue here and include the link below.
Maybe? If there is some genuine risk in the previous answer.
Before submitting this PR, please make sure you have:
next
branch OR only changed documentation/infrastructure (master
is stable and used in production)