feat(lint): add --all-variants flag for lint by chaospuppy · Pull Request #4783 · zarf-dev/zarf

chaospuppy · 2026-04-03T23:12:32Z

Description

This PR adds an --all-variants flag to the zarf dev lint command that will result in all variants of a zarf package being linted, even if there are multiple flavors present in the package definition. Previously, it was required that users specify a --flavor flag in order to pass validation. This is done to make linting zarf package in CI or in situations where you would otherwise not want to/could not know which flavor you wanted to lint specifically, and wished to validate the entire package.

Related Issue

Fixes #4598

Checklist before merging

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

netlify · 2026-04-03T23:12:39Z

✅ Deploy Preview for zarf-docs ready!

Name	Link
🔨 Latest commit	`dcbc628`
🔍 Latest deploy log	https://app.netlify.com/projects/zarf-docs/deploys/6a965ca876d95a000875127b
😎 Deploy Preview	https://deploy-preview-4783--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 · 2026-04-10T22:02:39Z

Codecov Report

❌ Patch coverage is 77.46479% with 16 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/cmd/dev.go	25.00%	9 Missing ⚠️
src/pkg/packager/load/import.go	77.77%	2 Missing and 2 partials ⚠️
src/pkg/packager/generate.go	0.00%	3 Missing ⚠️

Files with missing lines	Coverage Δ
src/internal/api/v1alpha1/validate.go	`90.14% <100.00%> (+0.43%)`	⬆️
src/pkg/packager/lint.go	`68.42% <100.00%> (+0.85%)`	⬆️
src/pkg/packager/load/load.go	`75.00% <100.00%> (+1.15%)`	⬆️
src/pkg/utils/oci_artifacts.go	`53.93% <100.00%> (+0.52%)`	⬆️
src/pkg/packager/generate.go	`0.00% <0.00%> (ø)`
src/pkg/packager/load/import.go	`55.75% <77.77%> (-0.10%)`	⬇️
src/cmd/dev.go	`36.83% <25.00%> (+<0.01%)`	⬆️

... and 2 files with indirect coverage changes

🚀 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.

AustinAbro321

This should be a nice win for linting, thanks! A few comments

AustinAbro321 · 2026-05-13T18:46:40Z

+components:
+  - name: duplicate
+    only:
+      flavor: first-flavor


Need to test importing a child components with flavors here

AustinAbro321 · 2026-05-13T18:47:53Z

 }

-func compatibleComponent(c v1alpha1.ZarfComponent, arch, flavor string) bool {
+func compatibleComponent(c v1alpha1.ZarfComponent, arch, flavor string, allVariants bool) bool {


I believe we'll also want all variants of architectures.

I interpreted this to mean we want allVariants to b evaluated within compatibleComponent for both flavor and arch checks, but I also see how it might be better to leave the function unchanged and instead do something like if !compatibleComponent && !allVariants.

AustinAbro321 · 2026-05-13T18:52:34Z

 	for _, component := range pkg.Components {
 		// ensure component name is unique
-		if _, ok := uniqueComponentNames[component.Name]; ok {
+		if _, ok := uniqueComponentNames[component.Name]; ok && !opts.SkipComponentNameUniquenessValidation {


This is too broad, let's change it so we only allow duplicate component names when the only blocks are not equal

Since we can have any number of components with duplicate names when this validation option is true, I needed to map component names to all of the only blocks associated with those component names. Let me know if I could simplify further, but I also didn't want to run reflect.DeepEqual unless we enabled SkipComponentNameUniquenessValidation.

AustinAbro321

Apologies for the delay in review. A few comments

AustinAbro321 · 2026-06-04T16:47:51Z

+	validationOpts := internalv1alpha1.ValidateOpts{}
+
+	if allVariants {
+		validationOpts.SkipComponentNameUniquenessValidation = true
+	}


Suggested change

validationOpts := internalv1alpha1.ValidateOpts{}

if allVariants {

validationOpts.SkipComponentNameUniquenessValidation = true

}

validationOpts := internalv1alpha1.ValidateOpts{

SkipComponentNameUniquenessValidation: allVariants,

}

AustinAbro321 · 2026-06-04T16:53:23Z

 		}
 		if len(found) == 0 {
 			return v1alpha1.ZarfPackage{}, fmt.Errorf("no compatible component named %s found", name)
 		} else if len(found) > 1 {


We'll now need to handle multiple components with the same name being found. Add a test for this as well

AustinAbro321 · 2026-06-04T16:56:24Z

+			// only check if only block is duplicated if we're skipping name uniqueness checks
+			if opts.SkipComponentNameUniquenessValidation {
+				duplicateOnly = slices.ContainsFunc(uniqueComponentNames[component.Name], func(o v1alpha1.ZarfComponentOnlyTarget) bool {
+					return reflect.DeepEqual(o, component.Only)


We generally avoid reflect, I'd do something like this instead

func onlyTargetsEqual(a, b v1alpha1.ZarfComponentOnlyTarget) bool { return a.LocalOS == b.LocalOS && a.Flavor == b.Flavor && a.Cluster.Architecture == b.Cluster.Architecture && slices.Equal(a.Cluster.Distros, b.Cluster.Distros) }

AustinAbro321 · 2026-06-04T16:57:40Z

 type DefinitionOptions struct {
-	Flavor       string
+	Flavor string
+	// All variants will ignore Flavor and will return all components, regardless of flavor


Suggested change

// All variants will ignore Flavor and will return all components, regardless of flavor

// All variants will ignore Flavor & architecture and will return all components. Mutually exclusive with flavor.

chaospuppy · 2026-07-17T17:59:03Z

@AustinAbro321 sorry for the delay on my end here, I've addressed the feedback you provided above. Setting allVariants will now result in multiple components of the same name but different only being imported.

AustinAbro321

I've not done a full review, but asking that this be in line with #5020

AustinAbro321 · 2026-07-27T18:09:15Z

-	Flavor       string
+	Flavor string
+	// All variants will ignore Flavor & architecture and will return all components. Mutually exclusive with flavor.
+	AllVariants  bool


There is similar work going on in #5020 src/pkg/packager/load/load.go. Instead of a boolean, let's copy over the variant Dimension construct, that way users can selectively add the filters that they want.

github-project-automation Bot added this to Zarf Apr 3, 2026

chaospuppy force-pushed the 4598-lint-without-flavor branch from dbc0447 to e8ffd82 Compare April 3, 2026 23:14

chaospuppy mentioned this pull request Apr 6, 2026

zarf dev lint fails if a flavor is not specified for a flavored package #4598

Open

chaospuppy marked this pull request as ready for review April 10, 2026 21:45

chaospuppy requested review from a team as code owners April 10, 2026 21:45

chaospuppy force-pushed the 4598-lint-without-flavor branch 3 times, most recently from 815d65f to b771fe5 Compare April 13, 2026 17:15

AustinAbro321 requested changes Apr 24, 2026

View reviewed changes

Comment thread src/pkg/packager/load/load.go Outdated

Comment thread src/pkg/packager/load/load.go

Comment thread src/internal/api/v1alpha1/validate.go

github-project-automation Bot moved this to In progress in Zarf Apr 24, 2026

chaospuppy force-pushed the 4598-lint-without-flavor branch from db6ce34 to a8d6f9d Compare May 1, 2026 20:59

chaospuppy commented May 1, 2026

View reviewed changes

Comment thread src/pkg/utils/error.go Outdated

chaospuppy requested a review from AustinAbro321 May 8, 2026 16:23

AustinAbro321 requested changes May 13, 2026

View reviewed changes

spencercjh mentioned this pull request May 28, 2026

zarf dev inspect manifests fails on packages with flavors #4947

Closed

AustinAbro321 requested changes Jun 4, 2026

View reviewed changes

AustinAbro321 mentioned this pull request Jun 30, 2026

fix: skeleton packages drop non-host-arch components #5020

Open

2 tasks

AustinAbro321 reviewed Jul 27, 2026

View reviewed changes

chaospuppy force-pushed the 4598-lint-without-flavor branch from cf56541 to c78dd6b Compare September 1, 2026 04:43

chaospuppy closed this Sep 1, 2026

chaospuppy force-pushed the 4598-lint-without-flavor branch from c78dd6b to dcbc628 Compare September 1, 2026 05:03

github-project-automation Bot moved this from In progress to Done in Zarf Sep 1, 2026

	// All variants will ignore Flavor and will return all components, regardless of flavor
	// All variants will ignore Flavor & architecture and will return all components. Mutually exclusive with flavor.

Uh oh!

Conversation

chaospuppy commented Apr 3, 2026

Description

Related Issue

Checklist before merging

Uh oh!

netlify Bot commented Apr 3, 2026 • 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 Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

AustinAbro321 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AustinAbro321 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chaospuppy commented Jul 17, 2026

Uh oh!

AustinAbro321 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify Bot commented Apr 3, 2026 •

edited

Loading

codecov Bot commented Apr 10, 2026 •

edited

Loading