bevy/tools/build-example-pages/Cargo.toml

[package]
name = "build-example-pages"
version = "0.9.0-dev"
edition = "2021"
description = "handle examples in Bevy"
publish = false
license = "MIT OR Apache-2.0"

[dependencies]
toml = "0.5"
tera = "1.15"
serde = { version = "1.0", features = [ "derive" ] }
bitflags = "1.3"
Examples metadata in Cargo.toml (#4741) # Objective - Have information about examples only in one place that can be used for the repo and for the website (and remove the need to keep a list of example to build for wasm in the website https://github.com/bevyengine/bevy-website/blob/75acb730406ef9c5928d37daf8bb32e4dbeb8b13/generate-wasm-examples/generate_wasm_examples.sh#L92-L99) ## Solution - Add metadata about examples in `Cargo.toml` - Build the `examples/README.md` from a template using those metadata. I used tera as the template engine to use the same tech as the website. - Make CI fail if an example is missing metadata, or if the readme file needs to be updated (the command to update it is displayed in the failed step in CI) ## Remaining To Do - After the next release with this merged in, the website will be able to be updated to use those metadata too - I would like to build the examples in wasm and make them available at http://dev-docs.bevyengine.org/ but that will require more design - https://github.com/bevyengine/bevy-website/issues/299 for other ToDos Co-authored-by: Readme <github-actions@github.com> 2022-06-25 20:23:24 +00:00			`[package]`
			`name = "build-example-pages"`
Bump Version after Release (#5576) Bump version after release This PR has been auto-generated 2022-08-05 02:03:05 +00:00			`version = "0.9.0-dev"`
Examples metadata in Cargo.toml (#4741) # Objective - Have information about examples only in one place that can be used for the repo and for the website (and remove the need to keep a list of example to build for wasm in the website https://github.com/bevyengine/bevy-website/blob/75acb730406ef9c5928d37daf8bb32e4dbeb8b13/generate-wasm-examples/generate_wasm_examples.sh#L92-L99) ## Solution - Add metadata about examples in `Cargo.toml` - Build the `examples/README.md` from a template using those metadata. I used tera as the template engine to use the same tech as the website. - Make CI fail if an example is missing metadata, or if the readme file needs to be updated (the command to update it is displayed in the failed step in CI) ## Remaining To Do - After the next release with this merged in, the website will be able to be updated to use those metadata too - I would like to build the examples in wasm and make them available at http://dev-docs.bevyengine.org/ but that will require more design - https://github.com/bevyengine/bevy-website/issues/299 for other ToDos Co-authored-by: Readme <github-actions@github.com> 2022-06-25 20:23:24 +00:00			`edition = "2021"`
			`description = "handle examples in Bevy"`
			`publish = false`
			`license = "MIT OR Apache-2.0"`

			`[dependencies]`
			`toml = "0.5"`
			`tera = "1.15"`
			`serde = { version = "1.0", features = [ "derive" ] }`
			`bitflags = "1.3"`