feat: introduce conversions between API versions by AustinAbro321 · Pull Request #4823 · zarf-dev/zarf

AustinAbro321 · 2026-04-13T19:06:48Z

Description

I had previously discussed the possibility of moving the deprecated types into their internal package, but I decided against this as I believe we want SDK users to be able to fully inspect the contents of their package. While variables are set for instance, we should let SDK users examine them.

relates to #3433

Checklist before merging

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

codecov · 2026-04-13T19:14:59Z

Codecov Report

❌ Patch coverage is 94.52991% with 96 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/cmd/dev_upgrade.go	66.66%	47 Missing and 1 partial ⚠️
src/internal/api/v1alpha1/convert.go	96.85%	20 Missing and 6 partials ⚠️
src/internal/api/v1beta1/convert.go	97.53%	12 Missing and 6 partials ⚠️
src/test/testutil/fuzz.go	90.00%	4 Missing ⚠️

Files with missing lines	Coverage Δ
src/api/convert/convert.go	`100.00% <100.00%> (ø)`
src/api/v1alpha1/package.go	`95.91% <100.00%> (+8.96%)`	⬆️
src/api/v1beta1/component.go	`81.81% <ø> (+38.96%)`	⬆️
src/api/v1beta1/package.go	`100.00% <100.00%> (+35.71%)`	⬆️
src/cmd/dev.go	`38.79% <100.00%> (+0.07%)`	⬆️
src/test/testutil/fuzz.go	`90.00% <90.00%> (ø)`
src/internal/api/v1beta1/convert.go	`97.53% <97.53%> (ø)`
src/internal/api/v1alpha1/convert.go	`96.85% <96.85%> (ø)`
src/cmd/dev_upgrade.go	`66.66% <66.66%> (ø)`

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

netlify · 2026-07-01T15:24:07Z

✅ Deploy Preview for zarf-docs canceled.

Name	Link
🔨 Latest commit	`99def50`
🔍 Latest deploy log	https://app.netlify.com/projects/zarf-docs/deploys/6a67644ab23b290008a6acab

Signed-off-by: Austin Abro <austinabro321@gmail.com>

soltysh

A few comments/questions, the reflection-based round tripping tests should help us uncover eventual missing bits. Those few I've pointed out are b/c AI told me 😅

soltysh · 2026-07-14T14:38:18Z

+		Name:         c.Name,
+		Description:  c.Description,
+		Optional:     c.Optional,
+		Service:      string(c.Service),


Here, the opposite, so Required: !c.Optional, to ensure that the generic struct has all the fields filled in.

I have not filled in every field in the generic struct, but rather let the conversion logic handle it so long as there is no information missing by filling out the newer, canonical field. In this case since required would always be nil, the conversion logic fallsback to using optional.

Signed-off-by: Austin Abro <austinabro321@gmail.com>

…api-conversions

Signed-off-by: Austin Abro <austinabro321@gmail.com>

brandtkeller

Adding some thoughts as I get time to test.

brandtkeller · 2026-07-24T23:17:05Z

+		Group:             c.DeprecatedGroup,
+		DataInjections:    dataInjectionsToGeneric(c.DataInjections),
+		HealthChecks:      healthChecksToGeneric(c.HealthChecks),
+		DeprecatedScripts: scriptsToGeneric(c.DeprecatedScripts),


Are we consuming DeprecatedScripts anywhere to perform the migration to actions?

Yes in the pkgcfg package, It should always be migrated right as v1alpha1 is parsed, and so technically not be needed in the migration logic, but I think it's still better to have the converter convert everything.

brandtkeller · 2026-07-24T23:26:48Z

+func actionSetToGeneric(s v1alpha1.ZarfComponentActionSet) types.ComponentActionSet {
+	defaults := types.ComponentActionDefaults{
+		Silent:          s.Defaults.Mute,
+		MaxTotalSeconds: int32(s.Defaults.MaxTotalSeconds),


seems negligible but do we need to add safe migrations from int to int32?

I'm not concerned about that honestly

Signed-off-by: Austin Abro <austinabro321@gmail.com>

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

AustinAbro321 mentioned this pull request Jun 2, 2026

feat(schema): update v1beta1 types #4704

Merged

2 tasks

soltysh reviewed Jun 9, 2026

View reviewed changes

Comment thread src/api/convert/convert.go Outdated

Comment thread src/internal/api/v1beta1/convert.go

Comment thread src/api/convert/convert_test.go

Base automatically changed from update-v1beta1-schema to main July 1, 2026 14:13

implement API conversions

54d2861

Signed-off-by: Austin Abro <austinabro321@gmail.com>

AustinAbro321 force-pushed the introduce-api-conversions branch from cfef0e1 to 54d2861 Compare July 1, 2026 16:43

AustinAbro321 added 2 commits July 1, 2026 13:35

convert

ec99a3d

Signed-off-by: Austin Abro <austinabro321@gmail.com>

zarf dev convert

56f36cc

Signed-off-by: Austin Abro <austinabro321@gmail.com>

AustinAbro321 marked this pull request as ready for review July 1, 2026 18:57

AustinAbro321 requested review from a team as code owners July 1, 2026 18:57

AustinAbro321 and others added 9 commits July 1, 2026 15:11

upgrade-schema

95f7339

Signed-off-by: Austin Abro <austinabro321@gmail.com>

upgrade

97ecf63

Signed-off-by: Austin Abro <austinabro321@gmail.com>

fix convert order

8f51cc2

Signed-off-by: Austin Abro <austinabro321@gmail.com>

convert

37350d9

Signed-off-by: Austin Abro <austinabro321@gmail.com>

rename

cb75ace

Signed-off-by: Austin Abro <austinabro321@gmail.com>

work regardless of path

e94969a

Signed-off-by: Austin Abro <austinabro321@gmail.com>

Merge branch 'main' into introduce-api-conversions

2d19eca

Merge branch 'main' into introduce-api-conversions

319738f

account for new fields

8af9b29

Signed-off-by: Austin Abro <austinabro321@gmail.com>

soltysh reviewed Jul 14, 2026

View reviewed changes

AustinAbro321 added 7 commits July 14, 2026 11:44

set required to optional

60c71f2

Signed-off-by: Austin Abro <austinabro321@gmail.com>

set required from api version

9ab1b04

Signed-off-by: Austin Abro <austinabro321@gmail.com>

add roundtrip test

ec2387c

Signed-off-by: Austin Abro <austinabro321@gmail.com>

exclude paths

f12cb20

Signed-off-by: Austin Abro <austinabro321@gmail.com>

fix template fields

971860e

Signed-off-by: Austin Abro <austinabro321@gmail.com>

full round trip

ec59b0f

Signed-off-by: Austin Abro <austinabro321@gmail.com>

simplify required conversion

0a766c0

Signed-off-by: Austin Abro <austinabro321@gmail.com>

AustinAbro321 added 5 commits July 14, 2026 15:22

roundtrip

9569a63

Signed-off-by: Austin Abro <austinabro321@gmail.com>

templated values files

389be65

Signed-off-by: Austin Abro <austinabro321@gmail.com>

fix git logic

ee1ba71

Signed-off-by: Austin Abro <austinabro321@gmail.com>

keep existing annotations

f434c7a

Signed-off-by: Austin Abro <austinabro321@gmail.com>

set original api version correctly

d86804e

Signed-off-by: Austin Abro <austinabro321@gmail.com>

AustinAbro321 requested a review from soltysh July 15, 2026 14:21

AustinAbro321 and others added 11 commits July 20, 2026 11:28

git conversions

1b32c5a

Signed-off-by: Austin Abro <austinabro321@gmail.com>

betterr tests

fbc0656

Signed-off-by: Austin Abro <austinabro321@gmail.com>

parse ref

76fa36a

Signed-off-by: Austin Abro <austinabro321@gmail.com>

fix refs

8f37c18

Signed-off-by: Austin Abro <austinabro321@gmail.com>

docs and schema

afbdd4a

Signed-off-by: Austin Abro <austinabro321@gmail.com>

change to new strategy

a0a37ab

Signed-off-by: Austin Abro <austinabro321@gmail.com>

convert test

76a67b3

Signed-off-by: Austin Abro <austinabro321@gmail.com>

add tests

ebe112f

Signed-off-by: Austin Abro <austinabro321@gmail.com>

Merge branch 'introduce-api-conversions-new-strategy' into introduce-…

ff9fd09

…api-conversions

Merge branch 'main' into introduce-api-conversions

946d520

make docs and schema

68b3d39

Signed-off-by: Austin Abro <austinabro321@gmail.com>

brandtkeller reviewed Jul 24, 2026

View reviewed changes

AustinAbro321 added 3 commits July 27, 2026 09:14

oneof required

ed6efd9

Signed-off-by: Austin Abro <austinabro321@gmail.com>

Merge branch 'main' into introduce-api-conversions

115dbef

docs and schema

99def50

Signed-off-by: Austin Abro <austinabro321@gmail.com>

AustinAbro321 requested a review from brandtkeller July 27, 2026 16:34

Uh oh!

Conversation

AustinAbro321 commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist before merging

Uh oh!

codecov Bot commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

netlify Bot commented Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for zarf-docs canceled.

Uh oh!

soltysh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

soltysh Jul 14, 2026

Choose a reason for hiding this comment

Uh oh!

AustinAbro321 Jul 15, 2026

Choose a reason for hiding this comment

Uh oh!

brandtkeller left a comment

Choose a reason for hiding this comment

Uh oh!

brandtkeller Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

AustinAbro321 Jul 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brandtkeller Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

AustinAbro321 Jul 27, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AustinAbro321 commented Apr 13, 2026 •

edited

Loading

codecov Bot commented Apr 13, 2026 •

edited

Loading

netlify Bot commented Jul 1, 2026 •

edited

Loading

AustinAbro321 Jul 27, 2026 •

edited

Loading