Skip to content

Commit 1316bb9

Browse files
xStromxStrom
authored
Prepare package configurations for publishing. (#478)
* Prepare package configurations for publishing. * Add a version field to `with_winit` to appease cargo-apk. * Remove backticks from package description. * Change the tests package description. * Add workspace version for unified version numbering. * Fix typo. * Tweak some comments.
1 parent 48ab91e commit 1316bb9

11 files changed

Lines changed: 54 additions & 65 deletions

File tree

‎Cargo.toml‎

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
[workspace]
22
resolver = "2"
3-
43
members = [
54
"crates/encoding",
65
"crates/shaders",
@@ -17,23 +16,29 @@ members = [
1716
]
1817

1918
[workspace.package]
19+
# Vello version, also used by other packages which want to mimic Vello's version.
20+
# Right now those packages include vello_encoding and vello_shaders.
21+
#
22+
# NOTE: When bumping this, remember to also bump the aforementioned other packages'
23+
# version in the dependencies section at the bottom of this file.
24+
# Additionally, bump the Vello dependency version in the 'simple' example.
25+
version = "0.1.0"
26+
2027
edition = "2021"
21-
version = "0.0.1"
22-
license = "MIT OR Apache-2.0"
28+
rust-version = "1.75"
29+
license = "Apache-2.0 OR MIT"
2330
repository = "https://github.com/linebender/vello"
2431

2532
[package]
2633
name = "vello"
27-
description = "An experimental GPU compute-centric 2D renderer"
34+
version.workspace = true
35+
description = "An experimental GPU compute-centric 2D renderer."
2836
categories = ["rendering", "graphics"]
2937
keywords = ["2d", "vector-graphics"]
30-
31-
# This crate is intended for publishing, but not ready yet
32-
publish = false
33-
34-
version.workspace = true
35-
license.workspace = true
38+
exclude = ["/.github/", "/doc/", "/examples/", ".gitignore"]
3639
edition.workspace = true
40+
rust-version.workspace = true
41+
license.workspace = true
3742
repository.workspace = true
3843

3944
[features]
@@ -42,19 +47,22 @@ hot_reload = []
4247
buffer_labels = []
4348

4449
[dependencies]
50+
vello_encoding = { workspace = true }
4551
bytemuck = { workspace = true }
4652
skrifa = { workspace = true }
4753
peniko = { workspace = true }
4854
wgpu = { workspace = true, optional = true }
49-
raw-window-handle = "0.6"
50-
futures-intrusive = "0.5.0"
51-
vello_encoding = { path = "crates/encoding" }
55+
raw-window-handle = { workspace = true }
56+
futures-intrusive = { workspace = true }
5257
wgpu-profiler = { workspace = true, optional = true }
5358

5459
[workspace.dependencies]
60+
vello_encoding = { version = "0.1.0", path = "crates/encoding" }
5561
bytemuck = { version = "1.14.3", features = ["derive"] }
5662
skrifa = "0.15.5"
5763
peniko = "0.1.0"
64+
futures-intrusive = "0.5.0"
65+
raw-window-handle = "0.6"
5866

5967
# NOTE: Make sure to keep this in sync with the version badge in README.md
6068
wgpu = { version = "0.19" }

‎crates/encoding/Cargo.toml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
[package]
22
name = "vello_encoding"
3-
version = "0.1.0"
3+
version.workspace = true # We mimic Vello's version
4+
description = "Vello types that represent the data that needs to be rendered."
45
edition.workspace = true
6+
rust-version.workspace = true
57
license.workspace = true
68
repository.workspace = true
79

‎crates/shaders/Cargo.toml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
[package]
22
name = "vello_shaders"
3-
version = "0.1.0"
3+
version.workspace = true # We mimic Vello's version
4+
description = "Vello infrastructure to preprocess and cross-compile shaders at compile time."
45
edition.workspace = true
6+
rust-version.workspace = true
57
license.workspace = true
68
repository.workspace = true
79

10+
publish = false # Remove this when the package is ready for publishing
11+
812
[features]
913
default = ["compile", "wgsl", "msl"]
1014
compile = ["naga", "thiserror"]

‎crates/tests/Cargo.toml‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
[package]
22
name = "vello_tests"
3+
description = "Integration tests for Vello."
34
edition.workspace = true
4-
version.workspace = true
55
license.workspace = true
66
repository.workspace = true
77
publish = false
88

9-
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
10-
119
[dependencies]
1210
vello = { path = "../.." }
1311
image = "0.24.9"
@@ -16,4 +14,4 @@ anyhow = { workspace = true }
1614
wgpu = { workspace = true }
1715
pollster = { workspace = true }
1816
png = "0.17.13"
19-
futures-intrusive = "0.5.0"
17+
futures-intrusive = { workspace = true }

‎examples/headless/Cargo.toml‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,19 @@
11
[package]
22
name = "headless"
3-
description = "An example showing how to use `vello` to create raster images"
4-
publish = false
5-
6-
version.workspace = true
7-
license.workspace = true
3+
description = "An example showing how to use Vello to create raster images."
84
edition.workspace = true
5+
license.workspace = true
96
repository.workspace = true
10-
11-
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
7+
publish = false
128

139
[dependencies]
14-
anyhow = { workspace = true }
15-
clap = { workspace = true, features = ["derive"] }
1610
vello = { path = "../../" }
1711
scenes = { path = "../scenes" }
12+
anyhow = { workspace = true }
13+
clap = { workspace = true, features = ["derive"] }
1814

1915
wgpu = { workspace = true }
2016
pollster = { workspace = true }
2117
env_logger = "0.11.2"
2218
png = "0.17.13"
23-
futures-intrusive = "0.5.0"
19+
futures-intrusive = { workspace = true }

‎examples/run_wasm/Cargo.toml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
[package]
22
name = "run_wasm"
3-
publish = false
4-
5-
version.workspace = true
6-
license.workspace = true
73
edition.workspace = true
4+
license.workspace = true
85
repository.workspace = true
9-
10-
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
6+
publish = false
117

128
[dependencies]
139
cargo-run-wasm = "0.3.2"

‎examples/scenes/Cargo.toml‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
[package]
22
name = "scenes"
3-
description = "Vello scenes used in the other examples"
4-
publish = false
5-
6-
version.workspace = true
7-
license.workspace = true
3+
description = "Vello scenes used in the other examples."
84
edition.workspace = true
5+
license.workspace = true
96
repository.workspace = true
10-
11-
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
7+
publish = false
128

139
[dependencies]
1410
vello = { path = "../../" }

‎examples/simple/Cargo.toml‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
[package]
22
name = "simple"
33
edition.workspace = true
4-
version.workspace = true
54
license.workspace = true
65
repository.workspace = true
76
publish = false
87

98
# The dependencies here are independent from the workspace versions
109
[dependencies]
10+
# When using this example outside of the original Vello workspace,
11+
# remove the path property of the following Vello dependency requirement.
12+
vello = { version = "0.1.0", path = "../../" }
1113
anyhow = "1.0.80"
1214
pollster = "0.3.0"
1315
wgpu = "0.19.1"
1416
winit = "0.29.11"
15-
vello = { path = "../../" }
16-
# When using, replace the above line with this:
17-
#vello = { git = "https://github.com/linebender/vello" }

‎examples/with_bevy/Cargo.toml‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
[package]
22
name = "with_bevy"
3-
description = "Example of using Vello in a Bevy application"
4-
5-
version.workspace = true
6-
license.workspace = true
3+
description = "Example of using Vello in a Bevy application."
74
edition.workspace = true
5+
license.workspace = true
86
repository.workspace = true
9-
10-
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
7+
publish = false
118

129
[dependencies]
10+
vello = { path = "../../" }
1311
bevy = { version = "0.13", features = [
1412
"bevy_winit",
1513
"bevy_core_pipeline",
@@ -19,5 +17,3 @@ bevy = { version = "0.13", features = [
1917
"x11",
2018
"tonemapping_luts",
2119
], default-features = false }
22-
23-
vello = { path = "../../" }

‎examples/with_winit/Cargo.toml‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
[package]
22
name = "with_winit"
3+
version = "0.0.0"
34
description = "An example using vello to render to a winit window"
4-
publish = false
5-
6-
version.workspace = true
7-
license.workspace = true
85
edition.workspace = true
6+
license.workspace = true
97
repository.workspace = true
10-
11-
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
8+
publish = false
129

1310
[lib]
1411
name = "with_winit"

0 commit comments

Comments
 (0)