chore: Update description for container env var option to mention debug mode #5787
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
moelasmar
reviewed
Aug 18, 2023
| @@ -166,7 +166,8 @@ def invoke_common_options(f): | |||
| click.option( | |||
| "--container-env-vars", | |||
| type=click.Path(exists=True), | |||
| help="JSON file containing environment variables to be set within the container environment", | |||
| help="JSON file containing environment variables to be set within the container " | |||
| "environment when used in a debugging session locally.", | |||
There was a problem hiding this comment.
do we need to mention that these are extra environment variables and not a replacement for --env-vars parameter?
There was a problem hiding this comment.
Maybe something like this can help make this a little more clear:
JSON file containing additional environment variables to be set within the container when used in a debugging session locally.
Adding the word "additional" and removed "environment"
moelasmar
approved these changes
Aug 21, 2023
mildaniel
approved these changes
Aug 23, 2023
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.
Which issue(s) does this change fix?
None.
Why is this change necessary?
Currently, the option to pass in environment variables to local related containers are scoped to only happen when a debugging option (eg.
--debug-port) is passed in. The description does not mention this, potentially causing confusion as to why the option is not working.How does it address the issue?
Mentions that the option sends environment variables only in a debugging session.
What side effects does this change have?
None.
Mandatory Checklist
PRs will only be reviewed after checklist is complete
make prpassesmake update-reproducible-reqsif dependencies were changedBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.