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

Deprecate configuration file types other than yaml and toml #3516

Closed
AustinAbro321 opened this issue Feb 19, 2025 · 0 comments · Fixed by #3517
Closed

Deprecate configuration file types other than yaml and toml #3516

AustinAbro321 opened this issue Feb 19, 2025 · 0 comments · Fixed by #3517

Comments

@AustinAbro321
Copy link
Contributor

We currently allow the default viper extensions - {"json", "toml", "yaml", "yml", "properties", "props", "prop", "hcl", "tfvars", "dotenv", "env", "ini"}. Many of these are inconvenient to use in the context of Zarf and supporting all of them adds complexity to a user by introducing unnecessary choices.

Additionally, Zarf may add custom parsing logic to config files to enable case sensitive map keys, which Viper does not support by default, see - zarf-dev/proposals#16.

The argument could be made to eliminate all but one choice. However, toml is useful for removing the layers of tabs that exist in yaml. Especially since configuration options tend to have three+ layers such as package.deploy.set. Yaml is useful for specifying maps and keeping parity with Helm charts. Many times the same a user will want to specify a value from a Helm values file, and keeping the option to copy and paste is convenient.

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 a pull request may close this issue.

1 participant