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
{{ message }}
Repository navigation
Commit 5bca294
Browse filesBrowse the repository at this point in the historyBrowse files
|**Author(s)**: | Max Maass <max.maass@iteratec.com> |
14
14
15
15
## Context
@@ -106,6 +106,7 @@ This could be considered "playing tricks" (by just adding a digit and relabeling
106
106
107
107
#### Disadvantages
108
108
1.**The proposal deviates from the SemVer standard** and is thus unexpected for people who do not know about it.
109
+
2.**Helm will likely not accept version numbers in this format**, as it is very strict about adherence to semver. Thus, this solution cannot be implemented while using Helm.
109
110
110
111
### Option 4: Semantic Versioning, Separate Versioning For Components
111
112
For completeness sake, we also include this option, in which each component is versioned separately, so that a breaking change in one component only changes the version number of that component.
@@ -153,15 +154,17 @@ This makes the proposal still not completely Semver compliant as the command lin
153
154
154
155
1.**MINOR version changes can be breaking to some users,**, but can be identified by looking at the embedded version number
155
156
2.**Version numbers can look confusing and require an explanation**
157
+
3.**Upgrading scanners in GitOps systems like Flux or ArgoCD is no longer possible using search-and-replace**, as it requires knowing the version number of the scanner in addition to that of the secureCodeBox.
156
158
157
159
## Decision
158
-
TBD
160
+
There is no perfect solution for this - either we have a large number of "breaking" changes that are only breaking for some subset of users, or we have minor releases that are breaking to some users.
161
+
Under these circumstances, we prefer a solution that allows us to easily indicate compatibility between operator and scanner, and makes it easy to use in a GitOps environment.
162
+
**We thus choose to use option 2: Breaking changes for individual scanners can be part of a minor release, and only globally relevant changes require a major release.**
163
+
This is in line with how we have practiced versioning over the last months, and simply makes it more explicit.
159
164
160
165
## Consequences
161
-
- Create a page in the documentation explaining the versioning scheme (as part of the yet-to-be-written "how to upgrade" page).
162
-
- Check the different files in the repo where the versioning and upgrading process are discussed, and make sure they are consistent with the new policy.
163
-
- Depending on the decision, potentially write a blog post explaining it.
164
-
- Depending on the decision, consider if automated compatibility tests that combine the most up-to-date operator and older scanners (plus, potentially, the reverse) would be a useful thing to have, to have an automated assurance that interoperability is actually maintained as advertised.
165
-
166
+
In the future, minor releases can contain changes that are breaking to some users.
167
+
These changes will be highlighted in the release notes.
168
+
Major releases will be used to indicate larger compatibility-breaking changes.
0 commit comments