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.

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

v2 Docs: Mention value from env as default value #1910

Merged
merged 1 commit into from
May 9, 2024

Conversation

sj14
Copy link

@sj14 sj14 commented May 9, 2024

What type of PR is this?

(REQUIRED)

  • documentation

What this PR does / why we need it:

(REQUIRED)

Mention that values from the environment can be used as default values in the generated docs when no Value was set for a flag. Without knowing this, it can easily lead to exposed secrets.

Which issue(s) this PR fixes:

(REQUIRED)

Related to #1902

Release Notes

(REQUIRED)

Docs: Mention that values from the environment can be used as default values in the generated docs when no Value was set for a flag.

@sj14 sj14 requested a review from a team as a code owner May 9, 2024 07:50
@sj14 sj14 changed the base branch from main to v2-maint May 9, 2024 07:54
@sj14 sj14 changed the title Docs: Mention value from env as default value v2 Docs: Mention value from env as default value May 9, 2024
@sj14 sj14 marked this pull request as draft May 9, 2024 07:54
@sj14 sj14 marked this pull request as ready for review May 9, 2024 08:09
Copy link
Contributor

@Juneezee Juneezee left a comment

Choose a reason for hiding this comment

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

Thanks!

Copy link

@ArangoGutierrez ArangoGutierrez left a comment

Choose a reason for hiding this comment

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

Thanks

Copy link
Member

@bartekpacia bartekpacia left a comment

Choose a reason for hiding this comment

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

LGTM!

@bartekpacia bartekpacia merged commit da85d0c into urfave:v2-maint May 9, 2024
11 checks passed
@sj14 sj14 deleted the sj/default-arg-value branch May 9, 2024 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants