From 9ee02e87d3eec330621e14e72166143dbb523a60 Mon Sep 17 00:00:00 2001 From: BD103 <59022059+BD103@users.noreply.github.com> Date: Fri, 26 Apr 2024 07:55:03 -0400 Subject: [PATCH] Remove `version` field for non-publish crates and update descriptions (#13100) # Objective - The [`version`] field in `Cargo.toml` is optional for crates not published on . - We have several `publish = false` tools in this repository that still have a version field, even when it's not useful. [`version`]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-version-field ## Solution - Remove the [`version`] field for all crates where `publish = false`. - Update the description on a few crates and remove extra newlines as well. --- benches/Cargo.toml | 3 +-- crates/bevy_ecs_compile_fail_tests/Cargo.toml | 1 - crates/bevy_macros_compile_fail_tests/Cargo.toml | 1 - crates/bevy_reflect_compile_fail_tests/Cargo.toml | 1 - errors/Cargo.toml | 4 +--- examples/mobile/Cargo.toml | 3 ++- tools/build-templated-pages/Cargo.toml | 4 +--- tools/build-wasm-example/Cargo.toml | 3 +-- tools/ci/Cargo.toml | 3 +-- tools/example-showcase/Cargo.toml | 4 +--- 10 files changed, 8 insertions(+), 19 deletions(-) diff --git a/benches/Cargo.toml b/benches/Cargo.toml index ee9d45953a..0c236a577e 100644 --- a/benches/Cargo.toml +++ b/benches/Cargo.toml @@ -1,8 +1,7 @@ [package] name = "benches" -version = "0.1.0" edition = "2021" -description = "Benchmarks for Bevy engine" +description = "Benchmarks that test Bevy's performance" publish = false license = "MIT OR Apache-2.0" diff --git a/crates/bevy_ecs_compile_fail_tests/Cargo.toml b/crates/bevy_ecs_compile_fail_tests/Cargo.toml index 2e1438f879..b800eb1b69 100644 --- a/crates/bevy_ecs_compile_fail_tests/Cargo.toml +++ b/crates/bevy_ecs_compile_fail_tests/Cargo.toml @@ -1,6 +1,5 @@ [package] name = "bevy_ecs_compile_fail_tests" -version = "0.1.0" edition = "2021" description = "Compile fail tests for Bevy Engine's entity component system" homepage = "https://bevyengine.org" diff --git a/crates/bevy_macros_compile_fail_tests/Cargo.toml b/crates/bevy_macros_compile_fail_tests/Cargo.toml index 3b90561066..1cb7492c64 100644 --- a/crates/bevy_macros_compile_fail_tests/Cargo.toml +++ b/crates/bevy_macros_compile_fail_tests/Cargo.toml @@ -1,6 +1,5 @@ [package] name = "bevy_macros_compile_fail_tests" -version = "0.1.0" edition = "2021" description = "Compile fail tests for Bevy Engine's various macros" homepage = "https://bevyengine.org" diff --git a/crates/bevy_reflect_compile_fail_tests/Cargo.toml b/crates/bevy_reflect_compile_fail_tests/Cargo.toml index 5af57acd62..13638b2314 100644 --- a/crates/bevy_reflect_compile_fail_tests/Cargo.toml +++ b/crates/bevy_reflect_compile_fail_tests/Cargo.toml @@ -1,6 +1,5 @@ [package] name = "bevy_reflect_compile_fail_tests" -version = "0.1.0" edition = "2021" description = "Compile fail tests for Bevy Engine's reflection system" homepage = "https://bevyengine.org" diff --git a/errors/Cargo.toml b/errors/Cargo.toml index d59a0b216a..32c7ca92c9 100644 --- a/errors/Cargo.toml +++ b/errors/Cargo.toml @@ -1,12 +1,10 @@ [package] name = "errors" -version = "0.1.0" edition = "2021" -description = "Bevy's error codes" +description = "Documentation and tests for Bevy's error codes" publish = false license = "MIT OR Apache-2.0" - [dependencies] bevy = { path = ".." } diff --git a/examples/mobile/Cargo.toml b/examples/mobile/Cargo.toml index b6bc2739b2..5ad8916515 100644 --- a/examples/mobile/Cargo.toml +++ b/examples/mobile/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "bevy_mobile_example" -version = "0.1.0" +# Version is required by `cargo-apk`, though this value will never change. +version = "0.0.0" edition = "2021" description = "Example for building an iOS or Android app with Bevy" publish = false diff --git a/tools/build-templated-pages/Cargo.toml b/tools/build-templated-pages/Cargo.toml index 4079d49e6d..f6277fb630 100644 --- a/tools/build-templated-pages/Cargo.toml +++ b/tools/build-templated-pages/Cargo.toml @@ -1,12 +1,10 @@ [package] name = "build-templated-pages" -version = "0.14.0-dev" edition = "2021" -description = "handle templated pages in Bevy repository" +description = "Tool that checks and fixes undocumented features and examples" publish = false license = "MIT OR Apache-2.0" - [dependencies] toml_edit = { version = "0.22.7", default-features = false, features = [ "parse", diff --git a/tools/build-wasm-example/Cargo.toml b/tools/build-wasm-example/Cargo.toml index 969a4d3077..c4cd766855 100644 --- a/tools/build-wasm-example/Cargo.toml +++ b/tools/build-wasm-example/Cargo.toml @@ -1,8 +1,7 @@ [package] name = "build-wasm-example" -version = "0.1.0" edition = "2021" -description = "Build an example for wasm" +description = "Tool for building example for WASM" publish = false license = "MIT OR Apache-2.0" diff --git a/tools/ci/Cargo.toml b/tools/ci/Cargo.toml index 611a6f318d..4e597e4724 100644 --- a/tools/ci/Cargo.toml +++ b/tools/ci/Cargo.toml @@ -1,8 +1,7 @@ [package] name = "ci" -version = "0.1.0" edition = "2021" -description = "CI script for Bevy" +description = "Tool that enables running CI checks locally." publish = false license = "MIT OR Apache-2.0" diff --git a/tools/example-showcase/Cargo.toml b/tools/example-showcase/Cargo.toml index 4058cdbed1..262df1e44b 100644 --- a/tools/example-showcase/Cargo.toml +++ b/tools/example-showcase/Cargo.toml @@ -1,12 +1,10 @@ [package] name = "example-showcase" -version = "0.14.0-dev" edition = "2021" -description = "Run examples" +description = "Tool for running examples or generating a showcase page for the website." publish = false license = "MIT OR Apache-2.0" - [dependencies] xshell = "0.2" clap = { version = "4.0", features = ["derive"] }