Uh oh!
There was an error while loading. Please reload this page.
docs: Add CRD versioning ADR - #712
Conversation
✅ Deploy Preview for stackable-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
sbernauer
left a comment
There was a problem hiding this comment.
LGTM in general, just some small remarks
| > [!TIP] | ||
| > This approach can be used for fields which opt into optional (experimental) features but still providing the ability to customize using the field. Using `Option<T>` will push the responsibility of dealing with `None` (eg. using a default fallback value) to the operator. | ||
| **TODO:** Can we detect the addition of an optional field and thus enable not needing to bump / introduce a new version? We *can* somehow reliable detect `Option`, but it is not guaranteed to be the `Option` (from the standard library) we expect. |
There was a problem hiding this comment.
I fear it's very complicated to determine this and I'm fine not automating this for now (and rely on human intelligence to determine if the version should bumped).
If we determine the breakingness however, I think we should be looking at the generated crd.yaml, not the Rust code. Maybe there are already some tools for that already ;)
There was a problem hiding this comment.
I fear it's very complicated to determine this and I'm fine not automating this for now
It is indeed very complicated. I would even say impossible to do it reliably (right). I just left this to note down a random thought I had.
If we determine the breakingness however, I think we should be looking at the generated crd.yaml, not the Rust code. Maybe there are already some tools for that already ;)
Sure, that also makes sense. If we would down that road, I would still explore defining this in Rust code. This would also enforce specific rules around code. But as stated above, this was mostly just a random thought which will be removed from the final ADR anyway.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Part of stackabletech/issues#642
Rendered