feat: default-required feature flag #2211
Closed
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: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
✅ Deploy Preview for zarf-docs canceled.
|
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Noxsios
added
needs-docs
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
This comment was marked as resolved.
This comment was marked as resolved.
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Noxsios
changed the title
optional: false)Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Noxsios
requested review from
jeff-mccoy,
Racer159,
lucasrod16,
mike-winberry and
Madeline-UX
as code owners
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
AustinAbro321
requested changes
May 1, 2024
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
lucasrod16
reviewed
May 28, 2024
Comment on lines
+27
to
+31
| ## Decision | ||
|
|
||
| Option 4. Introduce `.metadata.features` flags to `zarf.yaml` to allow for certain schema behavior to be configurable to the user. | ||
|
|
||
| The `features` key will be added to the `metadata` section of the package schema. This key will be an array of strings, where each string is the name of a beta feature that can be enabled. To enable a feature, the user will need to add the name of the feature to this array and edit the package schema accordingly. |
There was a problem hiding this comment.
I believe the .metadata.features field might not be necessary for this purpose. Have we considered keeping the required key optional in the schema and defaulting to required: true for all components unless explicitly set to required: false? This would achieve the same behavior as the default-required flag but without needing the feature flag.
|
This is going to be done in the v1 schema instead |
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.
Description
Refer to
adr/0025-required-optional.md.Related Issue
Fixes #2059
Type of change
Checklist before merging