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-shared crate #883

Merged
merged 5 commits into from
Oct 9, 2024
Merged

Conversation

Techassi
Copy link
Member

@Techassi Techassi commented Oct 7, 2024

Part of stackabletech/issues#642, prepares for YAML helpers in stackable-versioned (see https://github.com/stackabletech/operator-rs/tree/feat/stackable-versioned-yaml-output branch)

This crate initially contains code to be able to use our custom YAML serialization and CRD schema generation across workspace members. Previously, to get access to the specialized helper functions and traits one needed to import the complete stackable-operator crate. That's why this commit moves that piece of code into a shared place, which is way lighter to be imported by other workspace members. It additionally reworks the helpers to be slightly more generic. It still contains the docs URL replacer, which replaces the placeholder with the correct Stackable doc URL in doc comments and thus in OpenAPI schema descriptions.

Reviewer

Preview Give feedback

This crate initially contains code to be able to use our custom
YAML serialization across workspace members. Previously, to get
access to the specialized helper functions and traits one needed
to import the complete stackable-operator crate. That's why this
commit moves that piece of code into a shared place, which is way
lighter to be imported by other workspace members. It additionally
reworks the helpers to be slightly more generic. It still contains
the docs URL replacer, which replaces the placeholder with the
correct Stackable doc URL in doc comments and thus in OpenAPI
schema descriptions.
@Techassi Techassi added type/feature-new release-note/action-required Denotes a PR that introduces potentially breaking changes that require user action. labels Oct 7, 2024
@Techassi Techassi self-assigned this Oct 7, 2024
@Techassi Techassi changed the title feat: Add stackable-shared crate feat!: Add stackable-shared crate Oct 7, 2024
@sbernauer
Copy link
Member

New day new crate ^^

@Techassi Techassi marked this pull request as ready for review October 8, 2024 07:18
Copy link
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 otherwise

@Techassi Techassi requested a review from sbernauer October 8, 2024 12:12
@Techassi Techassi added this pull request to the merge queue Oct 9, 2024
Merged via the queue into main with commit 194d33e Oct 9, 2024
10 checks passed
@Techassi Techassi deleted the feat/stackable-shared-crate branch October 9, 2024 06:09
@lfrancke
Copy link
Member

You added the release note label but no release notes. Is this a user visible change?

@sbernauer
Copy link
Member

No, this is an internal change (theoretically users of the Rust crates are affected, but not end users)

@lfrancke
Copy link
Member

In that case I'll remove the label again, thank you.

@lfrancke lfrancke removed the release-note/action-required Denotes a PR that introduces potentially breaking changes that require user action. label Oct 16, 2024
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