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

Add examples for how to use environment variables #130

Merged
merged 2 commits into from
Sep 21, 2023
Merged

Add examples for how to use environment variables #130

merged 2 commits into from
Sep 21, 2023

Conversation

BogdanIrimie
Copy link
Contributor

Add docs example on how to override topaz config using environment variables.

@github-actions
Copy link

Pull Request Test Coverage Report for Build 6247629947

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 30.016%

Totals Coverage Status
Change from base Build 6245314775: 0.0%
Covered Lines: 1119
Relevant Lines: 3728

💛 - Coveralls

docs/config.md Outdated Show resolved Hide resolved
oanatmaria
oanatmaria previously approved these changes Sep 20, 2023
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
carabasdaniel
carabasdaniel previously approved these changes Sep 20, 2023
apoland
apoland previously approved these changes Sep 20, 2023
ogazitt
ogazitt previously approved these changes Sep 20, 2023
Copy link
Member

@gertd gertd left a comment

Choose a reason for hiding this comment

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

I assume token_placeholder and token_placeholder are environment variables? If so can we please make the UPPERCASE, so they are easier to spot when reading a config file.

@BogdanIrimie BogdanIrimie dismissed stale reviews from ogazitt and apoland via fadb2c7 September 21, 2023 07:57
@BogdanIrimie
Copy link
Contributor Author

I assume token_placeholder and token_placeholder are environment variables? If so can we please make the UPPERCASE, so they are easier to spot when reading a config file.

In this case, they are just random strings. The environment variable name determines the yaml path where the substitution will happen. I tried to improve the docs to describe the 2 cases (viper env substitution and interpolation).

docs/config.md Outdated Show resolved Hide resolved
@gertd gertd merged commit f90d0bb into main Sep 21, 2023
5 checks passed
@gertd gertd deleted the improve-docs branch September 21, 2023 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants