Configuration improvements - Environment variable support, docs, CLI flag tweaks #138
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
Fix path handling for windows in config tests Add JSON tags and make field naming more consistent Generate CLI flags from struct Flat map is generated on the fly (fewer allocations) Renames and minor tweaks Add CLI flag descriptions Rename file Minor restructuring Minor tweaks First draft of a documentation generation tool Adding templ code and some styling info Style tweaks Add option to disable file embedding Promote documentation code Add a warning for using tabs in struct tags
Maelkum
force-pushed
the
config-env-support
branch
from
5006c74 to
8929f40
Compare
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.
This PR makes a number of changes to the config loading.
Environment Variable Support
We can now use environment variables to set config options. Rules when multiple options are set:
Rules for environment variable naming - if the config option is worker=>runtime-path, then the environment variable is B7S_Worker_RuntimePath
CLI flags are defined in the config struct itself
Having CLI flags defined in a single place makes it easier to manage, has a single source of truth and makes it easier to see the connection between the config file structure and the corresponding CLI flag.
CLI flags also load their defaults from the package-level default config variable (more transparent what the defaults are).
Generating documentation from the code
Added a CLI tool (generate local HTML or serve via HTTP) to generate documentation from the code. The documentation showcases the config structure, config option type, CLI flags, environment variables and defaults for all options.
Sample of generated docs look can be seen here