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.

Sign up for GitHub

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

docs: introduce workspace attributes and add keywords #1077

Merged
merged 7 commits into from
Apr 13, 2023
Merged

docs: introduce workspace attributes and add keywords #1077

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
818c144
Update Cargo.toml
niklasad1 Apr 12, 2023
d97cf27
docs: add keywords publishing on crates.io
niklasad1 Apr 12, 2023
589f790
workspace: version and authors
niklasad1 Apr 13, 2023
7543732
Merge remote-tracking branch 'origin/na-introduce-workspace-attr-and-…
niklasad1 Apr 13, 2023
9a30e2f
use workspace dependencies to avoid speciyfing version
niklasad1 Apr 13, 2023
3db27c4
Update Cargo.toml
niklasad1 Apr 13, 2023
9b7d655
Merge remote-tracking branch 'origin/master' into na-introduce-worksp…
niklasad1 Apr 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any idea how it resolves this in dependencies; does it use the path relative to this workspace toml?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to https://doc.rust-lang.org/cargo/reference/workspaces.html#the-package-table it should work

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah; readme and license paths are relative to the workspace root, ok cool! Not so useful if you want to have crate specific readme's but good if you just want to use the same one for all crates, so makes sense to me!


[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" }
niklasad1 marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 1 addition & 2 deletions RELEASE-CHECKLIST.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions benches/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
24 changes: 14 additions & 10 deletions client/http-client/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.23", 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"
Expand Down
22 changes: 13 additions & 9 deletions client/transport/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
26 changes: 15 additions & 11 deletions client/wasm-client/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"] }
26 changes: 15 additions & 11 deletions client/ws-client/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
17 changes: 12 additions & 5 deletions core/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"] }
Expand Down
7 changes: 4 additions & 3 deletions examples/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
36 changes: 20 additions & 16 deletions jsonrpsee/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
18 changes: 11 additions & 7 deletions proc-macros/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
23 changes: 13 additions & 10 deletions server/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"] }
Expand All @@ -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" }
Expand Down
11 changes: 5 additions & 6 deletions test-utils/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
8 changes: 4 additions & 4 deletions tests/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
7 changes: 5 additions & 2 deletions tests/wasm-tests/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
niklasad1 marked this conversation as resolved.
Show resolved Hide resolved
publish = false

[dev-dependencies]
wasm-bindgen-test = "0.3.24"
Expand Down
Loading