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
Copy file name to clipboardExpand all lines: docs/development.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -134,6 +134,7 @@ The changes that are required to achieve these effects are typically the followi
134
134
- Rename `config/vX_Y_experimental` to `config/vX_Y`, and update the golang `package` statements
135
135
- Drop `_experimental` from all imports in `config/vX_Y`
136
136
- Update `MaxVersion` in `config/vX_Y/types/config.go` to delete the `PreRelease` field
137
+
- Update `config/vX_Y/config.go` to update the comment block on `ParseCompatibleVersion`
137
138
- Update `config/vX_Y/config_test.go` to test that the new stable version is valid and the old experimental version is invalid
138
139
- Update the `Accept` header in `internal/resource/url.go` to specify the new spec version.
139
140
@@ -142,9 +143,10 @@ The changes that are required to achieve these effects are typically the followi
142
143
- Copy `config/vX_Y` into `config/vX_(Y+1)_experimental`, and update the golang `package` statements
143
144
- Update all `config/vX_Y` imports in `config/vX_(Y+1)_experimental` to `config/vX_(Y+1)_experimental`
144
145
- Update `config/vX_(Y+1)_experimental/types/config.go` to set `MaxVersion` to the correct major/minor versions with `PreRelease` set to `"experimental"`
145
-
- Update `config/vX_(Y+1)_experimental/config.go` to point the `prev` import to the new stable `vX_Y` package
146
+
- Update `config/vX_(Y+1)_experimental/config.go` to point the `prev` import to the new stable `vX_Y` package and update the comment block on `ParseCompatibleVersion`
146
147
- Update `config/vX_(Y+1)_experimental/config_test.go` to test that the new stable version is invalid and the new experimental version is valid
147
148
- Update `config/vX_(Y+1)_experimental/translate/translate.go` to translate from the previous stable version. Update the `old_types` import, delete all functions except `translateIgnition` and `Translate`, and ensure `translateIgnition` translates the entire `Ignition` struct.
149
+
- Update `config/vX_(Y+1)_experimental/translate/translate_test.go` to point the `old` import to the new stable `vX_Y/types` package
148
150
- Update `config/config.go` imports to point to the experimental version.
149
151
- Update `config/config_test.go` to add the new experimental version to `TestConfigStructure`.
150
152
- Update `generate` to generate the new stable and experimental versions, and rerun `generate`.
@@ -155,17 +157,17 @@ Next, all places that imported `config/vX_Y_experimental` should be updated to `
155
157
156
158
Update `tests/register/register.go` in the following ways:
157
159
158
-
- Add import `config/vX_Y`
159
-
- Update import `config/vX_Y_experimental` to `config/vX_(Y+1)_experimental`
160
-
- Add `config/vX_Y`'s identifier to `configVersions` in `Register()`
160
+
- Add import `config/vX_Y/types`
161
+
- Update import `config/vX_Y_experimental/types` to `config/vX_(Y+1)_experimental/types`
162
+
- Add `config/vX_Y/types`'s identifier to `configVersions` in `Register()`
161
163
162
164
### Update the blackbox tests
163
165
164
166
Update the blackbox tests.
165
167
166
168
- Bump the invalid `-experimental` version in the relevant `VersionOnlyConfig` test in `tests/negative/general/config.go`.
167
169
- Find all tests using `X.Y.0-experimental` and alter them to use `X.Y.0`.
168
-
- Update the `Accept` header checks in `tests/servers.go` to specify the new spec version.
170
+
- Update the `Accept` header checks in `tests/servers/servers.go` to specify the new spec version.
169
171
170
172
### Update docs
171
173
@@ -176,6 +178,7 @@ Finally, update docs.
176
178
- In `docs/configuration-vX_(Y+1)_experimental.md`, update the version of the experimental spec in the heading and the `ignition.version` field.
177
179
- Add a section to `docs/migrating-configs.md`.
178
180
- In `docs/specs.md`, update the list of stable and experimental spec versions (listing the latest stable release first) and update the table listing the Ignition release where a spec has been marked as stable.
181
+
- 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.
0 commit comments