You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This checklist describes bumping the Ignition spec version, base version, and distro versions. If your scenario is different, modify to taste.
Stabilize Ignition spec version
Bump go.mod for new Ignition release and update vendor.
Update imports. Drop -experimental from Ignition spec versions in */translate_test.go.
Bump base version
Rename base/vB_exp to base/vB and update package statements. Update imports.
Copy base/vB to base/vB+1_exp.
Update package statements in base/vB+1_exp.
Bump distro version
Rename config/distro/vD_exp to config/distro/vD and update package statements. Update imports.
Drop -experimental from init() in config/config.go.
Drop -experimental from examples in docs/.
Copy config/distro/vD to config/distro/vD+1_exp.
Update package statements in config/distro/vD+1_exp. Bump its base dependency to base/vB+1_exp.
Import config/vD+1_exp in config/config.go and add distroC+1-experimental to init().
Bump Ignition spec version
Bump Ignition types imports and rename ToIgnI and TestToIgnI functions in base/vB+1_exp. Bump Ignition spec versions in base/vB+1_exp/translate_test.go.
Bump Ignition types imports in config/distro/vD+1_exp. Update ToIgnI function names, util calls, and header comments to ToIgnI+1.
Update docs
Update internal/doc/main.go to add the new stable spec and reference the new experimental spec in generate().
Run generate to regenerate spec docs.
Update docs/specs.md.
Update docs/upgrading-*.md for the new spec version. Copy the relevant section from Ignition's doc/migrating-configs.md, convert the configs to Butane configs, convert field names to snake case, and update wording as needed. Add subsections for any new Butane-specific features.
Note the stabilization in docs/release-notes.md, following the format of previous stabilizations. Drop the -exp version suffix from any notes for the upcoming release.
The text was updated successfully, but these errors were encountered:
Bumping spec versions
This checklist describes bumping the Ignition spec version,
base
version, and distro versions. If your scenario is different, modify to taste.Stabilize Ignition spec version
go.mod
for new Ignition release and update vendor.-experimental
from Ignition spec versions in*/translate_test.go
.Bump base version
base/vB_exp
tobase/vB
and updatepackage
statements. Update imports.base/vB
tobase/vB+1_exp
.package
statements inbase/vB+1_exp
.Bump distro version
config/distro/vD_exp
toconfig/distro/vD
and updatepackage
statements. Update imports.-experimental
frominit()
inconfig/config.go
.-experimental
from examples indocs/
.config/distro/vD
toconfig/distro/vD+1_exp
.package
statements inconfig/distro/vD+1_exp
. Bump its base dependency tobase/vB+1_exp
.config/vD+1_exp
inconfig/config.go
and adddistro
C+1-experimental
toinit()
.Bump Ignition spec version
ToIgnI
andTestToIgnI
functions inbase/vB+1_exp
. Bump Ignition spec versions inbase/vB+1_exp/translate_test.go
.config/distro/vD+1_exp
. UpdateToIgnI
function names,util
calls, and header comments toToIgnI+1
.Update docs
internal/doc/main.go
to add the new stable spec and reference the new experimental spec ingenerate()
.generate
to regenerate spec docs.docs/specs.md
.docs/upgrading-*.md
for the new spec version. Copy the relevant section from Ignition'sdoc/migrating-configs.md
, convert the configs to Butane configs, convert field names to snake case, and update wording as needed. Add subsections for any new Butane-specific features.docs/release-notes.md
, following the format of previous stabilizations. Drop the-exp
version suffix from any notes for the upcoming release.The text was updated successfully, but these errors were encountered: