Skip to content

Commit 8337a94

Browse files
committed
clarify inability to handle crate renames in kube-derive - closes #227
at least we know what we can't do atm.
1 parent 9e0cd42 commit 8337a94

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

kube-derive/src/lib.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,17 @@ use custom_resource::CustomResource;
196196
/// ```toml
197197
/// kube = { version = "...", features = ["derive"] }
198198
/// ```
199+
///
200+
/// ## Runtime dependencies
201+
/// Due to [rust-lang/rust#54363](https://github.com/rust-lang/rust/issues/54363), we cannot be resilient against crate renames within our generated code.
202+
/// It's therefore **required** that you have the following crates in scope, not renamed:
203+
///
204+
/// - `serde_json`
205+
/// - `k8s_openapi`
206+
/// - `schemars` (by default, unless `schema` feature disabled)
207+
///
208+
/// You are ultimately responsible for maintaining the versions and feature flags of these libraries.
209+
///
199210
/// [`kube`]: https://docs.rs/kube
200211
/// [`kube::Api`]: https://docs.rs/kube/*/kube/struct.Api.html
201212
/// [`k8s_openapi::Metadata`]: https://docs.rs/k8s-openapi/*/k8s_openapi/trait.Metadata.html

0 commit comments

Comments
 (0)