Fix expectation, stabilize tests, add versioning section

nextmv-io · Mar 15, 2024 · 7aed522 · 7aed522
1 parent f2e5f6c
commit 7aed522
Show file tree

Hide file tree

Showing 11 changed files with 18 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -31,3 +31,11 @@ nextmv community clone -a knapsack-gosdk
 
 For further information on how to get started, features, deployment, etc.,
 please refer to the [official documentation](https://docs.nextmv.io/docs/mixed-integer-programming).
+
+## Versioning
+
+We try our best to version our software thoughtfully and only break APIs and
+behaviors when we have a good reason to.
+
+* Minor (`v1.^.0`) tags: new features, might be breaking.
+* Patch (`v1.0.^`) tags: bug fixes.
diff --git a/tests/incentive-allocation/main_test.go b/tests/incentive-allocation/main_test.go
@@ -29,6 +29,7 @@ func TestGolden(t *testing.T) {
 			},
 			TransientFields: []golden.TransientField{
 				{Key: ".version.sdk", Replacement: golden.StableVersion},
+				{Key: ".version.go-mip", Replacement: golden.StableVersion},
 				{Key: ".statistics.result.duration", Replacement: golden.StableFloat},
 				{Key: ".statistics.run.duration", Replacement: golden.StableFloat},
 			},

diff --git a/tests/incentive-allocation/testdata/template_input.json.golden b/tests/incentive-allocation/testdata/template_input.json.golden
@@ -148,7 +148,7 @@
     "schema": "v1"
   },
   "version": {
-    "go-mip": "v1.5.0-dev.2",
+    "go-mip": "VERSION",
     "sdk": "VERSION"
   }
 }
diff --git a/tests/knapsack/main_test.go b/tests/knapsack/main_test.go
@@ -29,6 +29,7 @@ func TestGolden(t *testing.T) {
 			},
 			TransientFields: []golden.TransientField{
 				{Key: ".version.sdk", Replacement: golden.StableVersion},
+				{Key: ".version.go-mip", Replacement: golden.StableVersion},
 				{Key: ".statistics.result.duration", Replacement: golden.StableFloat},
 				{Key: ".statistics.run.duration", Replacement: golden.StableFloat},
 			},

diff --git a/tests/knapsack/testdata/template_input.json.golden b/tests/knapsack/testdata/template_input.json.golden
@@ -80,7 +80,7 @@
     "schema": "v1"
   },
   "version": {
-    "go-mip": "v1.5.0-dev.2",
+    "go-mip": "VERSION",
     "sdk": "VERSION"
   }
 }
diff --git a/tests/meal-allocation/main_test.go b/tests/meal-allocation/main_test.go
@@ -28,6 +28,7 @@ func TestGolden(t *testing.T) {
 			},
 			TransientFields: []golden.TransientField{
 				{Key: ".version.sdk", Replacement: golden.StableVersion},
+				{Key: ".version.go-mip", Replacement: golden.StableVersion},
 				{Key: ".statistics.result.duration", Replacement: golden.StableFloat},
 				{Key: ".statistics.run.duration", Replacement: golden.StableFloat},
 			},

diff --git a/tests/meal-allocation/testdata/template_input.json.golden b/tests/meal-allocation/testdata/template_input.json.golden
@@ -48,7 +48,7 @@
     "schema": "v1"
   },
   "version": {
-    "go-mip": "v1.5.0-dev.2",
+    "go-mip": "VERSION",
     "sdk": "VERSION"
   }
 }
diff --git a/tests/shift-scheduling/main_test.go b/tests/shift-scheduling/main_test.go
@@ -28,6 +28,7 @@ func TestGolden(t *testing.T) {
 			},
 			TransientFields: []golden.TransientField{
 				{Key: ".version.sdk", Replacement: golden.StableVersion},
+				{Key: ".version.go-mip", Replacement: golden.StableVersion},
 				{Key: ".statistics.result.duration", Replacement: golden.StableFloat},
 				{Key: ".statistics.run.duration", Replacement: golden.StableFloat},
 			},

diff --git a/tests/shift-scheduling/testdata/input.json.golden b/tests/shift-scheduling/testdata/input.json.golden
@@ -323,7 +323,7 @@
     "schema": "v1"
   },
   "version": {
-    "go-mip": "v1.5.0-dev.2",
+    "go-mip": "VERSION",
     "sdk": "VERSION"
   }
 }
diff --git a/tests/solve_control_parameters/main_test.go b/tests/solve_control_parameters/main_test.go
@@ -34,6 +34,7 @@ func TestGolden(t *testing.T) {
 			},
 			TransientFields: []golden.TransientField{
 				{Key: ".version.sdk", Replacement: golden.StableVersion},
+				{Key: ".version.go-mip", Replacement: golden.StableVersion},
 				{Key: ".statistics.result.duration", Replacement: golden.StableFloat},
 				{Key: ".statistics.run.duration", Replacement: golden.StableFloat},
 			},

diff --git a/tests/solve_control_parameters/testdata/template_input.json.golden b/tests/solve_control_parameters/testdata/template_input.json.golden
@@ -99,7 +99,7 @@
     "schema": "v1"
   },
   "version": {
-    "go-mip": "v1.5.0-dev.2",
+    "go-mip": "VERSION",
     "sdk": "VERSION"
   }
 }