fixup! Config: Restructure versioning to share types

gbjk · Oct 13, 2024 · 522cb73 · 522cb73
1 parent 73a9a54
commit 522cb73
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/config/versions/versions.go b/config/versions/versions.go
@@ -1,11 +1,11 @@
 /*
 versions handles config upgrades and downgrades
 
-  - Versions must be stateful, and not rely upon type definitions in the config pkg. Instead versions must localise types to avoid issues with subsequent changes
+  - Versions must be stateful, and not rely upon type definitions in the config pkg
 
-  - Versions must upgrade to the next version. Do not retrospectively change versions to match new type changes. Create a new version
+  - Instead versions should localise types into vN/types.go to avoid issues with subsequent changes
 
-  - Versions must be registered in import.go
+  - Versions must upgrade to the next version. Do not retrospectively change versions to match new type changes. Create a new version
 
   - Versions must implement ExchangeVersion or ConfigVersion, and may implement both
 */