feat: deprecate config file types other than yaml and toml #3517
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
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
✅ Deploy Preview for zarf-docs canceled.
|
Codecov ReportAttention: Patch coverage is
|
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
AustinAbro321
changed the title
AustinAbro321
changed the title
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
AustinAbro321
changed the title
Signed-off-by: Austin Abro <AustinAbro321@gmail.com>
mkcp
approved these changes
Feb 19, 2025
| @@ -9,7 +9,7 @@ import { Tabs, TabItem, Code } from "@astrojs/starlight/components"; | |||
|
|
|||
| Users can use a config file to easily control flags for `zarf init`, `zarf package create`, and `zarf package deploy` commands, as well as global flags (excluding `--confirm`), enabling a more straightforward and declarative workflow. | |||
|
|
|||
| Zarf supports config files written in common configuration file formats including `toml`, `json`, `yaml`, `ini` and `props`, and by default Zarf will look for a file called `zarf-config` with one of these filenames in the current working directory. To generate a blank config file you can run `zarf dev generate-config` with an optional output filename/format. For example, to create an empty config file with the `my-cool-env` in the yaml format, you can use `zarf dev generate-config my-cool-env.yaml`. | |||
| Zarf supports config files written in `toml` and `yaml`. By default Zarf will look for a file called `zarf-config` with one of these filenames in the current working directory. To generate a blank config file you can run `zarf dev generate-config` with an optional output filename/format. For example, to create an empty config file with the `my-cool-env` in the yaml format, you can use `zarf dev generate-config my-cool-env.yaml`. | |||
| @@ -474,6 +474,8 @@ func (o *devGenerateConfigOptions) run(_ *cobra.Command, args []string) error { | |||
| } | |||
|
|
|||
| v := getViper() | |||
| // TODO once other formats are fully deprecated move this to the global viper config | |||
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.
Related Issue
Fixes #3516
Checklist before merging