Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add stackable-versioned and k8s-version crates for CRD versioning #764

Merged
merged 45 commits into from
May 6, 2024

Conversation

Techassi
Copy link
Member

@Techassi Techassi commented Apr 4, 2024

Part of stackabletech/issues#507 (refinement)

Tasks

Preview Give feedback

Reviewer

Preview Give feedback

@Techassi Techassi self-assigned this Apr 4, 2024
crates/stackable-versioned/src/gen/mod.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/mod.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/mod.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/mod.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/mod.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/mod.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/attrs/container.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/version.rs Outdated Show resolved Hide resolved
@fhennig
Copy link
Contributor

fhennig commented Apr 8, 2024

I see that this is still a draft, but I already want to encourage the use of more comments in the code, especially more module-level comments like "This module is used for .. and called by ..." to make it easier to grasp the overall setup of the crate for someone that isn't familiar with it.

@Techassi
Copy link
Member Author

Techassi commented Apr 8, 2024

I usually wait till the last second to add (doc) comments to my code. I do this, because there is a high chance that code will change until the PR is merge-able and thus I want to avoid rewriting the comments over and over again.

So don't worry, there will be plenty of comments when this gets merged :)

crates/stackable-versioned/src/gen/field.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/field.rs Show resolved Hide resolved
crates/stackable-versioned/src/gen/field.rs Show resolved Hide resolved
crates/stackable-versioned/src/gen/field.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/field.rs Show resolved Hide resolved
crates/stackable-versioned/src/gen/field.rs Show resolved Hide resolved
crates/stackable-versioned/src/gen/field.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/field.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/field.rs Show resolved Hide resolved
crates/stackable-versioned/src/gen/vstruct.rs Outdated Show resolved Hide resolved
@Techassi
Copy link
Member Author

Techassi commented May 2, 2024

This PR now implements the basic code to generate a very basic versioned field. There are a bunch of improvements we need in there, but I would like to merge the PR as is, and then introduce missing features / improvements in follow-up PRs, as this PR is already quite big.

Some items we need to tackle are:

I'll add a few more comments before moving this PR into "Ready for Review".

@Techassi Techassi marked this pull request as ready for review May 2, 2024 13:34
@Techassi Techassi requested a review from NickLarsenNZ May 3, 2024 12:03
Copy link
Member

@NickLarsenNZ NickLarsenNZ left a comment

Choose a reason for hiding this comment

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

Nice one!

CHANGELOG.md Outdated Show resolved Hide resolved
Cargo.toml Show resolved Hide resolved
crates/k8s-version/CHANGELOG.md Show resolved Hide resolved
crates/k8s-version/Cargo.toml Show resolved Hide resolved
crates/k8s-version/src/api_version.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/field.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/field.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/vstruct.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/src/gen/vstruct.rs Outdated Show resolved Hide resolved
crates/stackable-versioned/tests/basic.rs Outdated Show resolved Hide resolved
@NickLarsenNZ NickLarsenNZ self-requested a review May 6, 2024 14:23
Copy link
Member

@NickLarsenNZ NickLarsenNZ left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants