Skip to content
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

chore: Update description for container env var option to mention debug mode #5787

Merged
merged 6 commits into from
Aug 23, 2023
Merged

chore: Update description for container env var option to mention debug mode #5787

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
38dad12
Update description for container env var option to mention debug mode
lucashuy Aug 17, 2023
f34c6e5
Mention debugging locally
lucashuy Aug 17, 2023
e8d4f68
Update schema
lucashuy Aug 17, 2023
30b0b25
Merge branch 'develop' of github.com:aws/aws-sam-cli into container_e…
lucashuy Aug 21, 2023
5b130f1
Updated description
lucashuy Aug 21, 2023
0e3f338
Make schema
lucashuy Aug 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion samcli/commands/local/cli_common/options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Copy link
Contributor

Choose a reason for hiding this comment

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

do we need to mention that these are extra environment variables and not a replacement for --env-vars parameter?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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"

),
click.option(
"--docker-volume-basedir",
Expand Down
Loading
Loading