docs: introduce workspace attributes and add keywords (#1077)

* Update Cargo.toml * docs: add keywords publishing on crates.io Close #970 * workspace: version and authors * use workspace dependencies to avoid speciyfing version * Update Cargo.toml
paritytech · Apr 13, 2023 · bddbcaf · bddbcaf
1 parent 9726a30
commit bddbcaf
Show file tree

Hide file tree

Showing 16 changed files with 170 additions and 108 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -16,3 +16,25 @@ members = [
 	"types",
 ]
 resolver = "2"
+
+[workspace.package]
+authors = ["Parity Technologies <admin@parity.io>", "Pierre Krieger <pierre.krieger1708@gmail.com>"]
+version = "0.16.2"
+edition = "2021"
+rust-version = "1.64.0"
+license = "MIT"
+repository = "https://github.com/paritytech/jsonrpsee"
+documentation = "https://docs.rs/jsonrpsee"
+homepage = "https://www.parity.io/"
+keywords = ["jsonrpc", "json", "http", "websocket", "WASM"]
+readme = "README.md"
+
+[workspace.dependencies]
+jsonrpsee-types = { path = "types", version = "0.16.2" }
+jsonrpsee-core = { path = "core", version = "0.16.2" }
+jsonrpsee-server = { path = "server", version = "0.16.2" }
+jsonrpsee-ws-client = { path = "client/ws-client", version = "0.16.2" }
+jsonrpsee-http-client = { path = "client/http-client", version = "0.16.2" }
+jsonrpsee-wasm-client = { path = "client/wasm-client", version = "0.16.2" }
+jsonrpsee-client-transport = { path = "client/transport", version = "0.16.2" }
+jsonrpsee-proc-macros = { path = "proc-macros", version = "0.16.2" }
diff --git a/RELEASE-CHECKLIST.md b/RELEASE-CHECKLIST.md
@@ -10,8 +10,7 @@ We also assume that ongoing work done is being merged directly to the `master` b
     on the changes to date. If unsure what to bump the version to (e.g. is it a major, minor or patch release), check with the
     Parity Tools team.
 
-3.  Bump the crate versions in `Cargo.toml` to whatever was decided in step 2. The easiest approach is to search and replace, checking
-    that you didn't replace any other crate versions along the way.
+3.  Bump the crate version (several locations) in `Cargo.toml` of the workspace to whatever was decided in step 2.
 
 4.  Update `CHANGELOG.md` to reflect the difference between this release and the last. If you're unsure of
     what to add, check with the Tools team. See the `CHANGELOG.md` file for details of the format it follows.

diff --git a/benches/Cargo.toml b/benches/Cargo.toml
@@ -1,10 +1,10 @@
 [package]
 name = "jsonrpsee-benchmarks"
-version = "0.16.2"
-authors = ["Parity Technologies <admin@parity.io>"]
 description = "Benchmarks for jsonrpsee"
-edition = "2021"
-license = "MIT"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
 publish = false
 
 [dependencies]

diff --git a/client/http-client/Cargo.toml b/client/http-client/Cargo.toml
@@ -1,20 +1,24 @@
 [package]
 name = "jsonrpsee-http-client"
-version = "0.16.2"
-authors = ["Parity Technologies <admin@parity.io>", "Pierre Krieger <pierre.krieger1708@gmail.com>"]
-description = "HTTP client for JSON-RPC"
-edition = "2021"
-license = "MIT"
-repository = "https://github.com/paritytech/jsonrpsee"
-homepage = "https://github.com/paritytech/jsonrpsee"
-documentation = "https://docs.rs/jsonrpsee-http-client"
+description = "JSON-RPC HTTP client"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+repository.workspace = true
+documentation.workspace = true
+homepage.workspace = true
+keywords.workspace = true
+readme.workspace = true
+publish = true
 
 [dependencies]
 async-trait = "0.1"
 hyper = { version = "0.14.10", features = ["client", "http1", "http2", "tcp"] }
 hyper-rustls = { version = "0.24", optional = true, default-features = false, features = ["http1", "tls12", "logging"] }
-jsonrpsee-types = { path = "../../types", version = "0.16.2" }
-jsonrpsee-core = { path = "../../core", version = "0.16.2", features = ["client", "http-helpers"] }
+jsonrpsee-types = { workspace = true }
+jsonrpsee-core = { workspace = true, features = ["client", "http-helpers"] }
 serde = { version = "1.0", default-features = false, features = ["derive"] }
 serde_json = "1.0"
 thiserror = "1.0"

diff --git a/client/transport/Cargo.toml b/client/transport/Cargo.toml
@@ -1,16 +1,20 @@
 [package]
 name = "jsonrpsee-client-transport"
-version = "0.16.2"
-authors = ["Parity Technologies <admin@parity.io>", "Pierre Krieger <pierre.krieger1708@gmail.com>"]
-description = "JSON-RPC client transport"
-edition = "2021"
-license = "MIT"
-repository = "https://github.com/paritytech/jsonrpsee"
-homepage = "https://github.com/paritytech/jsonrpsee"
-documentation = "https://docs.rs/jsonrpsee-client-transport"
+description = "JSON-RPC client transports"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+repository.workspace = true
+documentation.workspace = true
+homepage.workspace = true
+keywords.workspace = true
+readme.workspace = true
+publish = true
 
 [dependencies]
-jsonrpsee-core = { path = "../../core", version = "0.16.2", features = ["client"] }
+jsonrpsee-core = { workspace = true, features = ["client"] }
 tracing = "0.1.34"
 
 # optional

diff --git a/client/wasm-client/Cargo.toml b/client/wasm-client/Cargo.toml
@@ -1,15 +1,19 @@
 [package]
 name = "jsonrpsee-wasm-client"
-version = "0.16.2"
-authors = ["Parity Technologies <admin@parity.io>", "Pierre Krieger <pierre.krieger1708@gmail.com>"]
-description = "WASM client for JSON-RPC"
-edition = "2021"
-license = "MIT"
-repository = "https://github.com/paritytech/jsonrpsee"
-homepage = "https://github.com/paritytech/jsonrpsee"
-documentation = "https://docs.rs/jsonrpsee-wasm-client"
+description = "JSON-RPC WASM client"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+repository.workspace = true
+documentation.workspace = true
+homepage.workspace = true
+keywords.workspace = true
+readme.workspace = true
+publish = true
 
 [dependencies]
-jsonrpsee-types = { path = "../../types", version = "0.16.2" }
-jsonrpsee-client-transport = { path = "../transport", version = "0.16.2", features = ["web"] }
-jsonrpsee-core = { path = "../../core", version = "0.16.2", features = ["async-wasm-client"] }
+jsonrpsee-types = { workspace = true }
+jsonrpsee-client-transport = { workspace = true, features = ["web"] }
+jsonrpsee-core = { workspace = true, features = ["async-wasm-client"] }
diff --git a/client/ws-client/Cargo.toml b/client/ws-client/Cargo.toml
@@ -1,18 +1,22 @@
 [package]
 name = "jsonrpsee-ws-client"
-version = "0.16.2"
-authors = ["Parity Technologies <admin@parity.io>", "Pierre Krieger <pierre.krieger1708@gmail.com>"]
-description = "WebSocket client for JSON-RPC"
-edition = "2021"
-license = "MIT"
-repository = "https://github.com/paritytech/jsonrpsee"
-homepage = "https://github.com/paritytech/jsonrpsee"
-documentation = "https://docs.rs/jsonrpsee-ws-client"
+description = "JSON-RPC websocket client"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+repository.workspace = true
+documentation.workspace = true
+homepage.workspace = true
+keywords.workspace = true
+readme.workspace = true
+publish = true
 
 [dependencies]
-jsonrpsee-types = { path = "../../types", version = "0.16.2" }
-jsonrpsee-client-transport = { path = "../transport", version = "0.16.2", features = ["ws"] }
-jsonrpsee-core = { path = "../../core", version = "0.16.2", features = ["async-client"] }
+jsonrpsee-types = { workspace = true }
+jsonrpsee-client-transport = { workspace = true, features = ["ws"] }
+jsonrpsee-core = { workspace = true, features = ["async-client"] }
 http = "0.2.0"
 
 [dev-dependencies]

diff --git a/core/Cargo.toml b/core/Cargo.toml
@@ -1,16 +1,23 @@
 [package]
 name = "jsonrpsee-core"
-version = "0.16.2"
-authors = ["Parity Technologies <admin@parity.io>"]
 description = "Utilities for jsonrpsee"
-edition = "2021"
-license = "MIT"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+repository.workspace = true
+documentation.workspace = true
+homepage.workspace = true
+keywords.workspace = true
+readme.workspace = true
+publish = true
 
 [dependencies]
 anyhow = "1"
 async-trait = "0.1"
 beef = { version = "0.5.1", features = ["impl_serde"] }
-jsonrpsee-types = { path = "../types", version = "0.16.2" }
+jsonrpsee-types = { workspace = true }
 thiserror = "1"
 serde = { version = "1.0", default-features = false, features = ["derive"] }
 serde_json = { version = "1", features = ["raw_value"] }

diff --git a/examples/Cargo.toml b/examples/Cargo.toml
@@ -1,9 +1,10 @@
 [package]
 name = "jsonrpsee-examples"
-version = "0.16.2"
-authors = ["Parity Technologies <admin@parity.io>"]
 description = "Examples for jsonrpsee"
-edition = "2021"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
 publish = false
 
 [dev-dependencies]

diff --git a/jsonrpsee/Cargo.toml b/jsonrpsee/Cargo.toml
@@ -1,25 +1,29 @@
 [package]
 name = "jsonrpsee"
-description = "JSON-RPC crate"
-version = "0.16.2"
-authors = ["Parity Technologies <admin@parity.io>", "Pierre Krieger <pierre.krieger1708@gmail.com>"]
-license = "MIT"
-edition = "2021"
-repository = "https://github.com/paritytech/jsonrpsee"
-homepage = "https://github.com/paritytech/jsonrpsee"
-documentation = "https://docs.rs/jsonrpsee"
+description = "JSON-RPC client/server framework"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+repository.workspace = true
+documentation.workspace = true
+homepage.workspace = true
+keywords.workspace = true
+readme.workspace = true
+publish = true
 
 [dependencies]
 # No support for namespaced features yet so workspace dependencies are prefixed with `jsonrpsee-`.
 # See https://github.com/rust-lang/cargo/issues/5565 for more details.
-jsonrpsee-http-client = { path = "../client/http-client", version = "0.16.2", optional = true }
-jsonrpsee-ws-client = { path = "../client/ws-client", version = "0.16.2", optional = true }
-jsonrpsee-wasm-client = { path = "../client/wasm-client", version = "0.16.2", optional = true }
-jsonrpsee-client-transport = { path = "../client/transport", version = "0.16.2", optional = true }
-jsonrpsee-server = { path = "../server", version = "0.16.2", optional = true }
-jsonrpsee-proc-macros = { path = "../proc-macros", version = "0.16.2", optional = true }
-jsonrpsee-core = { path = "../core", version = "0.16.2", optional = true }
-jsonrpsee-types = { path = "../types", version = "0.16.2", optional = true }
+jsonrpsee-http-client = { workspace = true, optional = true }
+jsonrpsee-ws-client = { workspace = true, optional = true }
+jsonrpsee-wasm-client = { workspace = true, optional = true }
+jsonrpsee-client-transport = { workspace = true, optional = true }
+jsonrpsee-server = { workspace = true, optional = true }
+jsonrpsee-proc-macros = { workspace = true, optional = true }
+jsonrpsee-core = { workspace = true, optional = true }
+jsonrpsee-types = { workspace = true, optional = true }
 tracing = { version = "0.1.34", optional = true }
 
 [features]

diff --git a/proc-macros/Cargo.toml b/proc-macros/Cargo.toml
@@ -1,13 +1,17 @@
 [package]
 name = "jsonrpsee-proc-macros"
 description = "Procedueral macros for jsonrpsee"
-version = "0.16.2"
-authors = ["Parity Technologies <admin@parity.io>", "Pierre Krieger <pierre.krieger1708@gmail.com>"]
-license = "MIT"
-edition = "2021"
-repository = "https://github.com/paritytech/jsonrpsee"
-homepage = "https://github.com/paritytech/jsonrpsee"
-documentation = "https://docs.rs/jsonrpsee-proc-macros"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+repository.workspace = true
+documentation.workspace = true
+homepage.workspace = true
+keywords.workspace = true
+readme.workspace = true
+publish = true
 
 [lib]
 proc-macro = true

diff --git a/server/Cargo.toml b/server/Cargo.toml
@@ -1,18 +1,22 @@
 [package]
 name = "jsonrpsee-server"
-version = "0.16.2"
-authors = ["Parity Technologies <admin@parity.io>", "Pierre Krieger <pierre.krieger1708@gmail.com>"]
 description = "JSON-RPC server that supports HTTP and WebSocket transports"
-edition = "2021"
-license = "MIT"
-repository = "https://github.com/paritytech/jsonrpsee"
-homepage = "https://github.com/paritytech/jsonrpsee"
-documentation = "https://docs.rs/jsonrpsee-server"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+repository.workspace = true
+documentation.workspace = true
+homepage.workspace = true
+keywords.workspace = true
+readme.workspace = true
+publish = true
 
 [dependencies]
 futures-util = { version = "0.3.14", default-features = false, features = ["io", "async-await-macro"] }
-jsonrpsee-types = { path = "../types", version = "0.16.2" }
-jsonrpsee-core = { path = "../core", version = "0.16.2", features = ["server", "soketto", "http-helpers"] }
+jsonrpsee-types = { workspace = true }
+jsonrpsee-core = { workspace = true, features = ["server", "soketto", "http-helpers"] }
 tracing = "0.1.34"
 serde = "1"
 serde_json = { version = "1", features = ["raw_value"] }
@@ -23,7 +27,6 @@ tokio-stream = "0.1.7"
 hyper = { version = "0.14", features = ["server", "http1", "http2"] }
 tower = "0.4.13"
 
-
 [dev-dependencies]
 anyhow = "1"
 jsonrpsee-test-utils = { path = "../test-utils" }

diff --git a/test-utils/Cargo.toml b/test-utils/Cargo.toml
@@ -1,11 +1,10 @@
 [package]
 name = "jsonrpsee-test-utils"
-version = "0.16.2"
-authors = ["Parity Technologies <admin@parity.io>"]
-license = "MIT"
-edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
+publish = false
 
 [dependencies]
 anyhow = "1"

diff --git a/tests/Cargo.toml b/tests/Cargo.toml
@@ -1,10 +1,10 @@
 [package]
 name = "jsonrpsee-integration-tests"
-version = "0.16.2"
-authors = ["Parity Technologies <admin@parity.io>"]
 description = "Integration tests for jsonrpsee"
-edition = "2021"
-license = "MIT"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
 publish = false
 
 [dev-dependencies]

diff --git a/tests/wasm-tests/Cargo.toml b/tests/wasm-tests/Cargo.toml
@@ -1,7 +1,10 @@
 [package]
 name = "wasm-test"
-version = "0.1.0"
-edition = "2021"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
+publish = false
 
 [dev-dependencies]
 wasm-bindgen-test = "0.3.24"