bevy/tools/example-showcase/Cargo.toml

[package]
name = "example-showcase"
version = "0.14.0-dev"
edition = "2021"
description = "Run examples"
publish = false
license = "MIT OR Apache-2.0"


[dependencies]
xshell = "0.2"
clap = { version = "4.0", features = ["derive"] }
ron = "0.8"
toml_edit = { version = "0.22.7", default-features = false, features = [
  "parse",
] }
pbr = "1.1"

[lints]
workspace = true

[package.metadata.docs.rs]
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
all-features = true
new example showcase tool (#8561) # Objective - Replace the `example_showcase.sh` script - Helper tool to prepare the example page on the website ## Solution - Have a command to run all the examples: `cargo run -p example-showcase -- run` - Have a command to take screenshots of all examples: `cargo run -p example-showcase -- run --screenshot` - Have a command to build the markdown files for the website: `cargo run -p example-showcase -- build-website-list --content-folder content` - Have a command to build all the examples in wasm/WebGPU: `cargo run -p example-showcase -- build-web-gpu-examples --content-folder webgpus` (with `--website-hacks` to enable the hacks for the Bevy website: canvas id, resizing and loading bar) This is the first step to an improved example page (all examples marked as wasm, uses the card layout, has screenshots, reuse name, category and description from the metadata). As one of the goal is to have a page with WebGPU examples before the official release, this is not touching the example page for now but targeting a new one. <img width="1912" alt="Screenshot 2023-05-06 at 17 16 25" src="https://user-images.githubusercontent.com/8672791/236632744-4372c95f-c50a-4168-973f-349412548f33.png"> 2023-05-08 19:02:06 +00:00			`[package]`
			`name = "example-showcase"`
Bump Version after Release (#12020) Fixes #12016. Bump version after release This PR has been auto-generated Co-authored-by: Bevy Auto Releaser <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: François <mockersf@gmail.com> 2024-02-21 20:58:59 +00:00			`version = "0.14.0-dev"`
new example showcase tool (#8561) # Objective - Replace the `example_showcase.sh` script - Helper tool to prepare the example page on the website ## Solution - Have a command to run all the examples: `cargo run -p example-showcase -- run` - Have a command to take screenshots of all examples: `cargo run -p example-showcase -- run --screenshot` - Have a command to build the markdown files for the website: `cargo run -p example-showcase -- build-website-list --content-folder content` - Have a command to build all the examples in wasm/WebGPU: `cargo run -p example-showcase -- build-web-gpu-examples --content-folder webgpus` (with `--website-hacks` to enable the hacks for the Bevy website: canvas id, resizing and loading bar) This is the first step to an improved example page (all examples marked as wasm, uses the card layout, has screenshots, reuse name, category and description from the metadata). As one of the goal is to have a page with WebGPU examples before the official release, this is not touching the example page for now but targeting a new one. <img width="1912" alt="Screenshot 2023-05-06 at 17 16 25" src="https://user-images.githubusercontent.com/8672791/236632744-4372c95f-c50a-4168-973f-349412548f33.png"> 2023-05-08 19:02:06 +00:00			`edition = "2021"`
			`description = "Run examples"`
			`publish = false`
			`license = "MIT OR Apache-2.0"`

Add a `[lints]` entry for workspace members missing it (#11900) # Objective - Some workspace members do not inherit the global lints. ## Solution - Add a `[lints]` entry for all files returned by `rg --files-without-match -F "[lints]" **/Cargo.toml`, except the compile failure tests since these aren't part of the workspace. - Add some docstrings where needed. --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com> 2024-02-19 17:09:47 +00:00
new example showcase tool (#8561) # Objective - Replace the `example_showcase.sh` script - Helper tool to prepare the example page on the website ## Solution - Have a command to run all the examples: `cargo run -p example-showcase -- run` - Have a command to take screenshots of all examples: `cargo run -p example-showcase -- run --screenshot` - Have a command to build the markdown files for the website: `cargo run -p example-showcase -- build-website-list --content-folder content` - Have a command to build all the examples in wasm/WebGPU: `cargo run -p example-showcase -- build-web-gpu-examples --content-folder webgpus` (with `--website-hacks` to enable the hacks for the Bevy website: canvas id, resizing and loading bar) This is the first step to an improved example page (all examples marked as wasm, uses the card layout, has screenshots, reuse name, category and description from the metadata). As one of the goal is to have a page with WebGPU examples before the official release, this is not touching the example page for now but targeting a new one. <img width="1912" alt="Screenshot 2023-05-06 at 17 16 25" src="https://user-images.githubusercontent.com/8672791/236632744-4372c95f-c50a-4168-973f-349412548f33.png"> 2023-05-08 19:02:06 +00:00			`[dependencies]`
			`xshell = "0.2"`
			`clap = { version = "4.0", features = ["derive"] }`
			`ron = "0.8"`
fix deprecations from toml_edit (#12421) # Objective - `toml_edit` released a new patch that deprecates `Document` - this warns when Bevy builds, and CI deny warns ## Solution - fix deprecation warnings 2024-03-11 17:53:38 +00:00			`toml_edit = { version = "0.22.7", default-features = false, features = [`
			`"parse",`
			`] }`
Optimize wasm examples for the website (#8636) # Objective - Improve speed of loading examples on the website - Triggered by https://news.ycombinator.com/item?id=35996393 ## Solution - Use wasm-opt to optimize files for size. This reduces the files from 22mb to 13mb - Cloudflare doesn't set the correct `Content-Type` header by default for wasm files, add it manually. This enables wasm streaming and compression, dropping the transfer to 3.9mb The files with this script are deployed on optimized.wasm-pages.pages.dev if you want to test, you can replace this URL on a website deployed locally. 2023-05-19 17:57:54 +00:00			`pbr = "1.1"`
Make `feature(doc_auto_cfg)` work (#12642) # Objective - In #12366 `![cfg_attr(docsrs, feature(doc_auto_cfg))] `was added. But to apply it it needs `--cfg=docsrs` in rustdoc-args. ## Solution - Apply `--cfg=docsrs` to all crates and CI. I also added `[package.metadata.docs.rs]` to all crates to avoid adding code behind a feature and forget adding the metadata. Before: ![Screenshot 2024-03-22 at 00 51 57](https://github.com/bevyengine/bevy/assets/104745335/6a9dfdaa-8710-4784-852b-5f9b74e3522c) After: ![Screenshot 2024-03-22 at 00 51 32](https://github.com/bevyengine/bevy/assets/104745335/c5bd6d8e-8ddb-45b3-b844-5ecf9f88961c) 2024-03-23 02:22:52 +00:00
			`[lints]`
			`workspace = true`

			`[package.metadata.docs.rs]`
			`rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]`
			`all-features = true`