Add --set-values flags and migrate --set to alias new --set-variables #4466

mkcp · 2025-12-10T18:17:42Z

Description

This PR adds the --set-values flag so users can directly override values via the CLI, and begins the path to migrating --set. To do so, we add the --set-variables flag (or versions of it like --deploy-set-variables) and change the description of --set to indicate that it now aliases --set-variables. This alias is just a documentation change in the CLI help text: the flags function identically.

Related Issue

Fixes #4224

Checklist before merging

Test, docs, adr added or updated as needed
Contributor Guide Steps followed

…e --set description to indicate it's now an alias for this flag Signed-off-by: Kit Patella <[email protected]>

Signed-off-by: Kit Patella <[email protected]>

netlify · 2025-12-10T18:17:48Z

✅ Deploy Preview for zarf-docs ready!

Name	Link
🔨 Latest commit	`16e01f5`
🔍 Latest deploy log	https://app.netlify.com/projects/zarf-docs/deploys/6939d8376ed50900088437c9
😎 Deploy Preview	https://deploy-preview-4466--zarf-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

codecov · 2025-12-10T18:20:08Z

Codecov Report

❌ Patch coverage is 80.76923% with 10 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/cmd/package.go	52.38%	10 Missing ⚠️

Files with missing lines	Coverage Δ
src/cmd/dev.go	`46.41% <100.00%> (+1.12%)`	⬆️
src/cmd/initialize.go	`27.93% <100.00%> (+0.29%)`	⬆️
src/cmd/viper.go	`54.44% <ø> (ø)`
src/cmd/package.go	`38.19% <52.38%> (+0.02%)`	⬆️

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Signed-off-by: Kit Patella <[email protected]>

brandtkeller

migration makes sense - added some thoughts around guardrails natively available in cobra that we might consider.

brandtkeller · 2025-12-11T04:04:01Z

src/cmd/initialize.go


 	// Init package set variable flags
-	cmd.Flags().StringToStringVar(&o.setVariables, "set", v.GetStringMapString(VPkgDeploySet), lang.CmdInitFlagSet)
+	cmd.Flags().StringToStringVar(&o.setVariables, "set", v.GetStringMapString(VPkgDeploySet), "Alias for --set-variables")


Should we explicitly mark these as deprecated?

cmd.Flags().MarkDeprecated("set", "use --set-variables instead")

Rather than having a separate command as an alias that we mark as deprecated or hide, I think it would be better to use the builtin cobra functionality for aliasing a command. This leads to a more intuitive experience around viper config, and will lead to an easier time aliasing --set-values to --set in the future in the event that variables is fully replaced

For instance
cmd.Flags().StringToStringVarP(&o.setVariables, "set-variables", "set", v.GetStringMapString(VPkgCreateSet), lang.CmdPackageCreateFlagSetVariables)

brandtkeller · 2025-12-11T04:05:12Z

src/cmd/initialize.go

 	// Init package set variable flags
-	cmd.Flags().StringToStringVar(&o.setVariables, "set", v.GetStringMapString(VPkgDeploySet), lang.CmdInitFlagSet)
+	cmd.Flags().StringToStringVar(&o.setVariables, "set", v.GetStringMapString(VPkgDeploySet), "Alias for --set-variables")
+	cmd.Flags().StringToStringVar(&o.setVariables, "set-variables", v.GetStringMapString(VPkgDeploySet), lang.CmdInitFlagSetVariables)


Given this alias - do we need to mark these flags as mutually exclusive? I understand this to create a last-write-wins scenario if there were to be both used?

AustinAbro321 · 2025-12-11T13:26:40Z

src/cmd/initialize.go


 	// Init package set variable flags
-	cmd.Flags().StringToStringVar(&o.setVariables, "set", v.GetStringMapString(VPkgDeploySet), lang.CmdInitFlagSet)
+	cmd.Flags().StringToStringVar(&o.setVariables, "set", v.GetStringMapString(VPkgDeploySet), "Alias for --set-variables")


Rather than having a separate command as an alias that we mark as deprecated or hide, I think it would be better to use the builtin cobra functionality for aliasing a command. This leads to a more intuitive experience around viper config, and will lead to an easier time aliasing --set-values to --set in the future in the event that variables is fully replaced

For instance
cmd.Flags().StringToStringVarP(&o.setVariables, "set-variables", "set", v.GetStringMapString(VPkgCreateSet), lang.CmdPackageCreateFlagSetVariables)

AustinAbro321 · 2025-12-11T13:35:41Z

src/cmd/dev.go

-	cmd.Flags().StringToStringVar(&o.createSetVariables, "create-set", v.GetStringMapString(VPkgCreateSet), lang.CmdDevFlagSet)
-	cmd.Flags().StringToStringVar(&o.deploySetVariables, "deploy-set", v.GetStringMapString(VPkgDeploySet), lang.CmdPackageDeployFlagSet)
+	cmd.Flags().StringToStringVar(&o.createSetVariables, "create-set", v.GetStringMapString(VPkgCreateSet), "Alias for --create-set-variables")
+	cmd.Flags().StringToStringVar(&o.createSetVariables, "create-set-variables", v.GetStringMapString(VPkgCreateSet), lang.CmdDevFlagSetVariables)


IMO we shouldn't add the variables verbiage to create time templates. Generally I think we should refer to these as package templates. I just noticed that Zarf is inconsistent right now since we call them package variables in this flag, and package templates in our docs. Still, I don't think we'll ever have two types of package templates, at least not in the same API version, so I'm not sure extra verbosity is helpful.

AustinAbro321 · 2025-12-11T13:37:13Z

src/cmd/viper.go

 	VPkgDeployNamespace  = "package.deploy.namespace"
 	VPkgRetries          = "package.deploy.retries"
 	VPkgDeployValues     = "package.deploy.values"
+	VPkgDeploySetValues  = "package.deploy.set_values"


Currently both package.deploy.values and package.deploy.set_values are in use. Not sure which I prefer, but we should only use one.

AustinAbro321 · 2025-12-11T13:42:18Z

src/cmd/package.go

 	v := getViper()
 	o.setVariables = helpers.TransformAndMergeMap(
 		v.GetStringMapString(VPkgDeploySet), o.setVariables, strings.ToUpper)
+	o.setValues = helpers.TransformAndMergeMap(


When there is no transform happening, this function is simply a maps.Copy, lets just use that instead.

mkcp added 2 commits December 10, 2025 10:09

add --set-variables and --create/deploy-set-variables flags and chang…

d6236fc

…e --set description to indicate it's now an alias for this flag Signed-off-by: Kit Patella <[email protected]>

make docs-and-schema for new flags

618d0f9

Signed-off-by: Kit Patella <[email protected]>

mkcp self-assigned this Dec 10, 2025

github-project-automation bot added this to Zarf Dec 10, 2025

mkcp added 2 commits December 10, 2025 12:13

add --set-values flags

8b906ba

Signed-off-by: Kit Patella <[email protected]>

test --set-values in e2e

7edc0e2

Signed-off-by: Kit Patella <[email protected]>

mkcp moved this to In progress in Zarf Dec 10, 2025

mkcp added 3 commits December 10, 2025 12:28

make sure set-values from zarf-conf are merged in correctly in dev cmds

27a1534

Signed-off-by: Kit Patella <[email protected]>

make docs-and-schema

94718e8

Signed-off-by: Kit Patella <[email protected]>

Merge branch 'main' into mkcp/migrate-vars-flags

16e01f5

mkcp marked this pull request as ready for review December 10, 2025 20:56

mkcp requested review from a team as code owners December 10, 2025 20:56

brandtkeller requested changes Dec 11, 2025

View reviewed changes

AustinAbro321 requested changes Dec 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add --set-values flags and migrate --set to alias new --set-variables #4466

Add --set-values flags and migrate --set to alias new --set-variables #4466

Uh oh!

mkcp commented Dec 10, 2025 •

edited

Loading

Uh oh!

netlify bot commented Dec 10, 2025 •

edited

Loading

Uh oh!

codecov bot commented Dec 10, 2025 •

edited

Loading

Uh oh!

brandtkeller left a comment

Uh oh!

brandtkeller Dec 11, 2025

Uh oh!

AustinAbro321 Dec 11, 2025

Uh oh!

brandtkeller Dec 11, 2025

Uh oh!

AustinAbro321 Dec 11, 2025

Uh oh!

AustinAbro321 Dec 11, 2025

Uh oh!

AustinAbro321 Dec 11, 2025

Uh oh!

AustinAbro321 Dec 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Add --set-values flags and migrate --set to alias new --set-variables #4466

Are you sure you want to change the base?

Add --set-values flags and migrate --set to alias new --set-variables #4466

Uh oh!

Conversation

mkcp commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Checklist before merging

Uh oh!

netlify bot commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for zarf-docs ready!

Uh oh!

codecov bot commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

brandtkeller left a comment

Choose a reason for hiding this comment

Uh oh!

brandtkeller Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

AustinAbro321 Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

brandtkeller Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

AustinAbro321 Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

AustinAbro321 Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

AustinAbro321 Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

AustinAbro321 Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mkcp commented Dec 10, 2025 •

edited

Loading

netlify bot commented Dec 10, 2025 •

edited

Loading

codecov bot commented Dec 10, 2025 •

edited

Loading