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 topaz configuration document #76

Merged
merged 5 commits into from Apr 27, 2023
Merged

Add topaz configuration document #76

merged 5 commits into from Apr 27, 2023

Conversation

carabasdaniel
Copy link
Contributor

@carabasdaniel carabasdaniel commented Apr 20, 2023

Closes: #75

@coveralls
Copy link

coveralls commented Apr 20, 2023

Pull Request Test Coverage Report for Build 4811526512

  • 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 38.188%

Totals Coverage Status
Change from base Build 4810316457: 0.0%
Covered Lines: 1180
Relevant Lines: 3090

💛 - Coveralls

@carabasdaniel carabasdaniel marked this pull request as ready for review April 24, 2023 08:51
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Show resolved Hide resolved
docs/examples/config-private-ghcr.yaml Outdated Show resolved Hide resolved
@gertd
Copy link
Member

gertd commented Apr 25, 2023

I suggest we add an explicit paragraph on using environment variables inside the config file.

Right now, we only show using ${TOPAZ_DIR}, but it does not get explained in terms of behavior. For example, what happens when the env variable is not existing? It will return an empty string., effectively making it a NOP.

Added a bit more info on local vs remote directory
ogazitt
ogazitt previously approved these changes Apr 25, 2023
gertd
gertd previously approved these changes Apr 26, 2023
@ogazitt ogazitt merged commit f346be4 into main Apr 27, 2023
6 checks passed
@ogazitt ogazitt deleted the config-doc branch April 27, 2023 17:10
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.

Document topaz config format
4 participants