docs: Add CRD versioning ADR by Techassi · Pull Request #712 · stackabletech/documentation · GitHub
Skip to content

docs: Add CRD versioning ADR#712

Draft
Techassi wants to merge 3 commits intomainfrom
adr/crd-versioning
Draft

docs: Add CRD versioning ADR#712
Techassi wants to merge 3 commits intomainfrom
adr/crd-versioning

Conversation

@Techassi
Copy link
Copy Markdown
Member

@Techassi Techassi commented Feb 25, 2025

@Techassi Techassi self-assigned this Feb 25, 2025
@netlify
Copy link
Copy Markdown

netlify Bot commented Feb 25, 2025

Copy link
Copy Markdown
Member

@sbernauer sbernauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in general, just some small remarks

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ;)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread modules/contributor/pages/adr/ADR000-crd-versioning.md
Comment thread modules/contributor/pages/adr/ADR000-crd-versioning.md
@sbernauer sbernauer moved this from Development: In Progress to Development: In Review in Stackable Engineering Apr 28, 2025
@sbernauer sbernauer moved this from Development: In Review to Development: In Progress in Stackable Engineering Apr 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants