Fix docs.rs build for non-root crate + minor release tweaks (kube-rs#683

) * set k8s-openapi feature for all creatse in docs.rs builds fixes docs.rs builds for non-root crates Signed-off-by: clux <[email protected]> * minor notes about release cargo release had a bug fix in 0.18.3 that i raised Signed-off-by: clux <[email protected]>
hasheddan · Oct 27, 2021 · 16c4bf2 · 16c4bf2
1 parent ba2efe4
commit 16c4bf2
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ Select a version of `kube` along with the generated [k8s-openapi](https://github
 
 ```toml
 [dependencies]
-kube = "0.63.1"
+kube = { version = "0.63.1", features = ["runtime","derive"] }
 k8s-openapi = { version = "0.13.1", default-features = false, features = ["v1_22"] }
 ```
 

diff --git a/kube-client/Cargo.toml b/kube-client/Cargo.toml
@@ -32,7 +32,7 @@ deprecated-crd-v1beta1 = ["kube-core/deprecated-crd-v1beta1"]
 __non_core = ["tracing", "serde_yaml", "base64"]
 
 [package.metadata.docs.rs]
-features = ["client", "native-tls", "rustls-tls", "ws", "oauth", "jsonpatch", "admission"]
+features = ["client", "native-tls", "rustls-tls", "ws", "oauth", "jsonpatch", "admission", "k8s-openapi/v1_22"]
 # Define the configuration attribute `docsrs`. Used to enable `doc_cfg` feature.
 rustdoc-args = ["--cfg", "docsrs"]
 

diff --git a/kube-core/Cargo.toml b/kube-core/Cargo.toml
@@ -12,6 +12,10 @@ license = "Apache-2.0"
 repository = "https://github.com/kube-rs/kube-rs"
 readme = "../README.md"
 
+[package.metadata.docs.rs]
+features = ["ws", "admission", "jsonpatch", "k8s-openapi/v1_22"]
+rustdoc-args = ["--cfg", "docsrs"]
+
 [features]
 ws = []
 admission = ["json-patch"]

diff --git a/kube-runtime/Cargo.toml b/kube-runtime/Cargo.toml
@@ -8,11 +8,17 @@ authors = [
 ]
 license = "Apache-2.0"
 repository = "https://github.com/kube-rs/kube-rs"
+readme = "../README.md"
 keywords = ["kubernetes", "runtime", "reflector", "watcher", "controller"]
 categories = ["web-programming::http-client"]
 rust-version = "1.56"
 edition = "2021"
 
+[package.metadata.docs.rs]
+features = ["k8s-openapi/v1_22"]
+# Define the configuration attribute `docsrs`. Used to enable `doc_cfg` feature.
+rustdoc-args = ["--cfg", "docsrs"]
+
 [dependencies]
 futures = "0.3.17"
 kube-client = { path = "../kube-client", version = "^0.63.0", default-features = false, features = ["jsonpatch", "client"] }

diff --git a/release.toml b/release.toml
@@ -1,4 +1,6 @@
-# Release process :: cargo-release @ 0.18.0
+# Release process :: cargo-release >= 0.18.3
+#
+# Dependencies: cargo-release, cargo-tree, sd, ripgrep
 #
 # 0. (optional) cargo release minor ; verify readme + changelog bumped; then git reset --hard
 # 1. PUBLISH_GRACE_SLEEP=20 cargo release minor --execute
@@ -9,7 +11,6 @@
 
 # Reference
 # https://github.com/sunng87/cargo-release/blob/master/docs/reference.md
-# Dependencies in hooks; cargo-release, cargo-tree, sd, ripgrep
 
 consolidate-commits = true
 shared-version = true

diff --git a/scripts/release-pre.sh b/scripts/release-pre.sh
@@ -23,6 +23,7 @@ sanity() {
     echo "prerelease: abort: recommending k8s-openapi pinned to a different version to what we use"
     exit 1
   fi
+  # TODO: verify versions of tools for release?
 }
 
 main() {
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,6 +23,7 @@ sanity() { @@
         echo "prerelease: abort: recommending k8s-openapi pinned to a different version to what we use"
         exit 1
       fi
+      # TODO: verify versions of tools for release?
     }
     main() {
@@ Expand Down @@