Skip to content

Commit bddbcaf

Browse files
authored
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
1 parent 9726a30 commit bddbcaf

File tree

16 files changed

+170
-108
lines changed

16 files changed

+170
-108
lines changed

Cargo.toml

+22
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,25 @@ members = [
1616
"types",
1717
]
1818
resolver = "2"
19+
20+
[workspace.package]
21+
authors = ["Parity Technologies <[email protected]>", "Pierre Krieger <[email protected]>"]
22+
version = "0.16.2"
23+
edition = "2021"
24+
rust-version = "1.64.0"
25+
license = "MIT"
26+
repository = "https://github.com/paritytech/jsonrpsee"
27+
documentation = "https://docs.rs/jsonrpsee"
28+
homepage = "https://www.parity.io/"
29+
keywords = ["jsonrpc", "json", "http", "websocket", "WASM"]
30+
readme = "README.md"
31+
32+
[workspace.dependencies]
33+
jsonrpsee-types = { path = "types", version = "0.16.2" }
34+
jsonrpsee-core = { path = "core", version = "0.16.2" }
35+
jsonrpsee-server = { path = "server", version = "0.16.2" }
36+
jsonrpsee-ws-client = { path = "client/ws-client", version = "0.16.2" }
37+
jsonrpsee-http-client = { path = "client/http-client", version = "0.16.2" }
38+
jsonrpsee-wasm-client = { path = "client/wasm-client", version = "0.16.2" }
39+
jsonrpsee-client-transport = { path = "client/transport", version = "0.16.2" }
40+
jsonrpsee-proc-macros = { path = "proc-macros", version = "0.16.2" }

RELEASE-CHECKLIST.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ We also assume that ongoing work done is being merged directly to the `master` b
1010
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
1111
Parity Tools team.
1212

13-
3. Bump the crate versions in `Cargo.toml` to whatever was decided in step 2. The easiest approach is to search and replace, checking
14-
that you didn't replace any other crate versions along the way.
13+
3. Bump the crate version (several locations) in `Cargo.toml` of the workspace to whatever was decided in step 2.
1514

1615
4. Update `CHANGELOG.md` to reflect the difference between this release and the last. If you're unsure of
1716
what to add, check with the Tools team. See the `CHANGELOG.md` file for details of the format it follows.

benches/Cargo.toml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[package]
22
name = "jsonrpsee-benchmarks"
3-
version = "0.16.2"
4-
authors = ["Parity Technologies <[email protected]>"]
53
description = "Benchmarks for jsonrpsee"
6-
edition = "2021"
7-
license = "MIT"
4+
version.workspace = true
5+
authors.workspace = true
6+
edition.workspace = true
7+
license.workspace = true
88
publish = false
99

1010
[dependencies]

client/http-client/Cargo.toml

+14-10
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
[package]
22
name = "jsonrpsee-http-client"
3-
version = "0.16.2"
4-
authors = ["Parity Technologies <[email protected]>", "Pierre Krieger <[email protected]>"]
5-
description = "HTTP client for JSON-RPC"
6-
edition = "2021"
7-
license = "MIT"
8-
repository = "https://github.com/paritytech/jsonrpsee"
9-
homepage = "https://github.com/paritytech/jsonrpsee"
10-
documentation = "https://docs.rs/jsonrpsee-http-client"
3+
description = "JSON-RPC HTTP client"
4+
version.workspace = true
5+
authors.workspace = true
6+
edition.workspace = true
7+
rust-version.workspace = true
8+
license.workspace = true
9+
repository.workspace = true
10+
documentation.workspace = true
11+
homepage.workspace = true
12+
keywords.workspace = true
13+
readme.workspace = true
14+
publish = true
1115

1216
[dependencies]
1317
async-trait = "0.1"
1418
hyper = { version = "0.14.10", features = ["client", "http1", "http2", "tcp"] }
1519
hyper-rustls = { version = "0.24", optional = true, default-features = false, features = ["http1", "tls12", "logging"] }
16-
jsonrpsee-types = { path = "../../types", version = "0.16.2" }
17-
jsonrpsee-core = { path = "../../core", version = "0.16.2", features = ["client", "http-helpers"] }
20+
jsonrpsee-types = { workspace = true }
21+
jsonrpsee-core = { workspace = true, features = ["client", "http-helpers"] }
1822
serde = { version = "1.0", default-features = false, features = ["derive"] }
1923
serde_json = "1.0"
2024
thiserror = "1.0"

client/transport/Cargo.toml

+13-9
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
[package]
22
name = "jsonrpsee-client-transport"
3-
version = "0.16.2"
4-
authors = ["Parity Technologies <[email protected]>", "Pierre Krieger <[email protected]>"]
5-
description = "JSON-RPC client transport"
6-
edition = "2021"
7-
license = "MIT"
8-
repository = "https://github.com/paritytech/jsonrpsee"
9-
homepage = "https://github.com/paritytech/jsonrpsee"
10-
documentation = "https://docs.rs/jsonrpsee-client-transport"
3+
description = "JSON-RPC client transports"
4+
version.workspace = true
5+
authors.workspace = true
6+
edition.workspace = true
7+
rust-version.workspace = true
8+
license.workspace = true
9+
repository.workspace = true
10+
documentation.workspace = true
11+
homepage.workspace = true
12+
keywords.workspace = true
13+
readme.workspace = true
14+
publish = true
1115

1216
[dependencies]
13-
jsonrpsee-core = { path = "../../core", version = "0.16.2", features = ["client"] }
17+
jsonrpsee-core = { workspace = true, features = ["client"] }
1418
tracing = "0.1.34"
1519

1620
# optional

client/wasm-client/Cargo.toml

+15-11
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
[package]
22
name = "jsonrpsee-wasm-client"
3-
version = "0.16.2"
4-
authors = ["Parity Technologies <[email protected]>", "Pierre Krieger <[email protected]>"]
5-
description = "WASM client for JSON-RPC"
6-
edition = "2021"
7-
license = "MIT"
8-
repository = "https://github.com/paritytech/jsonrpsee"
9-
homepage = "https://github.com/paritytech/jsonrpsee"
10-
documentation = "https://docs.rs/jsonrpsee-wasm-client"
3+
description = "JSON-RPC WASM client"
4+
version.workspace = true
5+
authors.workspace = true
6+
edition.workspace = true
7+
rust-version.workspace = true
8+
license.workspace = true
9+
repository.workspace = true
10+
documentation.workspace = true
11+
homepage.workspace = true
12+
keywords.workspace = true
13+
readme.workspace = true
14+
publish = true
1115

1216
[dependencies]
13-
jsonrpsee-types = { path = "../../types", version = "0.16.2" }
14-
jsonrpsee-client-transport = { path = "../transport", version = "0.16.2", features = ["web"] }
15-
jsonrpsee-core = { path = "../../core", version = "0.16.2", features = ["async-wasm-client"] }
17+
jsonrpsee-types = { workspace = true }
18+
jsonrpsee-client-transport = { workspace = true, features = ["web"] }
19+
jsonrpsee-core = { workspace = true, features = ["async-wasm-client"] }

client/ws-client/Cargo.toml

+15-11
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
[package]
22
name = "jsonrpsee-ws-client"
3-
version = "0.16.2"
4-
authors = ["Parity Technologies <[email protected]>", "Pierre Krieger <[email protected]>"]
5-
description = "WebSocket client for JSON-RPC"
6-
edition = "2021"
7-
license = "MIT"
8-
repository = "https://github.com/paritytech/jsonrpsee"
9-
homepage = "https://github.com/paritytech/jsonrpsee"
10-
documentation = "https://docs.rs/jsonrpsee-ws-client"
3+
description = "JSON-RPC websocket client"
4+
version.workspace = true
5+
authors.workspace = true
6+
edition.workspace = true
7+
rust-version.workspace = true
8+
license.workspace = true
9+
repository.workspace = true
10+
documentation.workspace = true
11+
homepage.workspace = true
12+
keywords.workspace = true
13+
readme.workspace = true
14+
publish = true
1115

1216
[dependencies]
13-
jsonrpsee-types = { path = "../../types", version = "0.16.2" }
14-
jsonrpsee-client-transport = { path = "../transport", version = "0.16.2", features = ["ws"] }
15-
jsonrpsee-core = { path = "../../core", version = "0.16.2", features = ["async-client"] }
17+
jsonrpsee-types = { workspace = true }
18+
jsonrpsee-client-transport = { workspace = true, features = ["ws"] }
19+
jsonrpsee-core = { workspace = true, features = ["async-client"] }
1620
http = "0.2.0"
1721

1822
[dev-dependencies]

core/Cargo.toml

+12-5
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,23 @@
11
[package]
22
name = "jsonrpsee-core"
3-
version = "0.16.2"
4-
authors = ["Parity Technologies <[email protected]>"]
53
description = "Utilities for jsonrpsee"
6-
edition = "2021"
7-
license = "MIT"
4+
version.workspace = true
5+
authors.workspace = true
6+
edition.workspace = true
7+
rust-version.workspace = true
8+
license.workspace = true
9+
repository.workspace = true
10+
documentation.workspace = true
11+
homepage.workspace = true
12+
keywords.workspace = true
13+
readme.workspace = true
14+
publish = true
815

916
[dependencies]
1017
anyhow = "1"
1118
async-trait = "0.1"
1219
beef = { version = "0.5.1", features = ["impl_serde"] }
13-
jsonrpsee-types = { path = "../types", version = "0.16.2" }
20+
jsonrpsee-types = { workspace = true }
1421
thiserror = "1"
1522
serde = { version = "1.0", default-features = false, features = ["derive"] }
1623
serde_json = { version = "1", features = ["raw_value"] }

examples/Cargo.toml

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
[package]
22
name = "jsonrpsee-examples"
3-
version = "0.16.2"
4-
authors = ["Parity Technologies <[email protected]>"]
53
description = "Examples for jsonrpsee"
6-
edition = "2021"
4+
version.workspace = true
5+
authors.workspace = true
6+
edition.workspace = true
7+
license.workspace = true
78
publish = false
89

910
[dev-dependencies]

jsonrpsee/Cargo.toml

+20-16
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,29 @@
11
[package]
22
name = "jsonrpsee"
3-
description = "JSON-RPC crate"
4-
version = "0.16.2"
5-
authors = ["Parity Technologies <[email protected]>", "Pierre Krieger <[email protected]>"]
6-
license = "MIT"
7-
edition = "2021"
8-
repository = "https://github.com/paritytech/jsonrpsee"
9-
homepage = "https://github.com/paritytech/jsonrpsee"
10-
documentation = "https://docs.rs/jsonrpsee"
3+
description = "JSON-RPC client/server framework"
4+
version.workspace = true
5+
authors.workspace = true
6+
edition.workspace = true
7+
rust-version.workspace = true
8+
license.workspace = true
9+
repository.workspace = true
10+
documentation.workspace = true
11+
homepage.workspace = true
12+
keywords.workspace = true
13+
readme.workspace = true
14+
publish = true
1115

1216
[dependencies]
1317
# No support for namespaced features yet so workspace dependencies are prefixed with `jsonrpsee-`.
1418
# See https://github.com/rust-lang/cargo/issues/5565 for more details.
15-
jsonrpsee-http-client = { path = "../client/http-client", version = "0.16.2", optional = true }
16-
jsonrpsee-ws-client = { path = "../client/ws-client", version = "0.16.2", optional = true }
17-
jsonrpsee-wasm-client = { path = "../client/wasm-client", version = "0.16.2", optional = true }
18-
jsonrpsee-client-transport = { path = "../client/transport", version = "0.16.2", optional = true }
19-
jsonrpsee-server = { path = "../server", version = "0.16.2", optional = true }
20-
jsonrpsee-proc-macros = { path = "../proc-macros", version = "0.16.2", optional = true }
21-
jsonrpsee-core = { path = "../core", version = "0.16.2", optional = true }
22-
jsonrpsee-types = { path = "../types", version = "0.16.2", optional = true }
19+
jsonrpsee-http-client = { workspace = true, optional = true }
20+
jsonrpsee-ws-client = { workspace = true, optional = true }
21+
jsonrpsee-wasm-client = { workspace = true, optional = true }
22+
jsonrpsee-client-transport = { workspace = true, optional = true }
23+
jsonrpsee-server = { workspace = true, optional = true }
24+
jsonrpsee-proc-macros = { workspace = true, optional = true }
25+
jsonrpsee-core = { workspace = true, optional = true }
26+
jsonrpsee-types = { workspace = true, optional = true }
2327
tracing = { version = "0.1.34", optional = true }
2428

2529
[features]

proc-macros/Cargo.toml

+11-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
[package]
22
name = "jsonrpsee-proc-macros"
33
description = "Procedueral macros for jsonrpsee"
4-
version = "0.16.2"
5-
authors = ["Parity Technologies <[email protected]>", "Pierre Krieger <[email protected]>"]
6-
license = "MIT"
7-
edition = "2021"
8-
repository = "https://github.com/paritytech/jsonrpsee"
9-
homepage = "https://github.com/paritytech/jsonrpsee"
10-
documentation = "https://docs.rs/jsonrpsee-proc-macros"
4+
version.workspace = true
5+
authors.workspace = true
6+
edition.workspace = true
7+
rust-version.workspace = true
8+
license.workspace = true
9+
repository.workspace = true
10+
documentation.workspace = true
11+
homepage.workspace = true
12+
keywords.workspace = true
13+
readme.workspace = true
14+
publish = true
1115

1216
[lib]
1317
proc-macro = true

server/Cargo.toml

+13-10
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
[package]
22
name = "jsonrpsee-server"
3-
version = "0.16.2"
4-
authors = ["Parity Technologies <[email protected]>", "Pierre Krieger <[email protected]>"]
53
description = "JSON-RPC server that supports HTTP and WebSocket transports"
6-
edition = "2021"
7-
license = "MIT"
8-
repository = "https://github.com/paritytech/jsonrpsee"
9-
homepage = "https://github.com/paritytech/jsonrpsee"
10-
documentation = "https://docs.rs/jsonrpsee-server"
4+
version.workspace = true
5+
authors.workspace = true
6+
edition.workspace = true
7+
rust-version.workspace = true
8+
license.workspace = true
9+
repository.workspace = true
10+
documentation.workspace = true
11+
homepage.workspace = true
12+
keywords.workspace = true
13+
readme.workspace = true
14+
publish = true
1115

1216
[dependencies]
1317
futures-util = { version = "0.3.14", default-features = false, features = ["io", "async-await-macro"] }
14-
jsonrpsee-types = { path = "../types", version = "0.16.2" }
15-
jsonrpsee-core = { path = "../core", version = "0.16.2", features = ["server", "soketto", "http-helpers"] }
18+
jsonrpsee-types = { workspace = true }
19+
jsonrpsee-core = { workspace = true, features = ["server", "soketto", "http-helpers"] }
1620
tracing = "0.1.34"
1721
serde = "1"
1822
serde_json = { version = "1", features = ["raw_value"] }
@@ -23,7 +27,6 @@ tokio-stream = "0.1.7"
2327
hyper = { version = "0.14", features = ["server", "http1", "http2"] }
2428
tower = "0.4.13"
2529

26-
2730
[dev-dependencies]
2831
anyhow = "1"
2932
jsonrpsee-test-utils = { path = "../test-utils" }

test-utils/Cargo.toml

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
[package]
22
name = "jsonrpsee-test-utils"
3-
version = "0.16.2"
4-
authors = ["Parity Technologies <[email protected]>"]
5-
license = "MIT"
6-
edition = "2021"
7-
8-
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
3+
version.workspace = true
4+
authors.workspace = true
5+
edition.workspace = true
6+
license.workspace = true
7+
publish = false
98

109
[dependencies]
1110
anyhow = "1"

tests/Cargo.toml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[package]
22
name = "jsonrpsee-integration-tests"
3-
version = "0.16.2"
4-
authors = ["Parity Technologies <[email protected]>"]
53
description = "Integration tests for jsonrpsee"
6-
edition = "2021"
7-
license = "MIT"
4+
version.workspace = true
5+
authors.workspace = true
6+
edition.workspace = true
7+
license.workspace = true
88
publish = false
99

1010
[dev-dependencies]

tests/wasm-tests/Cargo.toml

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
[package]
22
name = "wasm-test"
3-
version = "0.1.0"
4-
edition = "2021"
3+
version.workspace = true
4+
authors.workspace = true
5+
edition.workspace = true
6+
license.workspace = true
7+
publish = false
58

69
[dev-dependencies]
710
wasm-bindgen-test = "0.3.24"

0 commit comments

Comments
 (0)