Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-30 00:20:20 +00:00
Code Issues Projects Releases Packages Wiki Activity
bevy/tools/build-templated-pages/Cargo.toml

14 lines
360 B
TOML
Raw Normal View History

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]
Feature documentation (#7814) # Objective - Fixes #1800, fixes #6984 - Alternative to #7196 - Ensure feature list is always up to date and that all are documented - Help discovery of features ## Solution - Use a template to update the cargo feature list - Use the comment just above the feature declaration as the description - Add the checks to CI - Add the features to the base crate doc
2023-02-28 14:24:47 +00:00
name = "build-templated-pages"
Release 0.12 (#10362) Preparing next 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>
2023-11-04 17:24:23 +00:00
version = "0.12.0"
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"
Feature documentation (#7814) # Objective - Fixes #1800, fixes #6984 - Alternative to #7196 - Ensure feature list is always up to date and that all are documented - Help discovery of features ## Solution - Use a template to update the cargo feature list - Use the comment just above the feature declaration as the description - Add the checks to CI - Add the features to the base crate doc
2023-02-28 14:24:47 +00:00
description = "handle templated pages in Bevy repository"
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
publish = false
license = "MIT OR Apache-2.0"
[dependencies]
Bump toml_edit in build-template-pages tool (#11342) # Objective - The [`build-templated-pages`](https://github.com/bevyengine/bevy/tree/4778fbeb65d840eb39bda017fd428ebfc17a1153/tools/build-templated-pages) tool is used to render the Markdown templates in the [docs-template](https://github.com/bevyengine/bevy/tree/4778fbeb65d840eb39bda017fd428ebfc17a1153/docs-template) folder. - It depends on out outdated version of `toml_edit`. ## Solution - Bump `toml_edit` to 0.21, disabling all features except `parse`.
2024-01-16 05:23:18 +00:00
toml_edit = { version = "0.21", default-features = false, features = ["parse"] }
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
tera = "1.15"
Standardize toml format with taplo (#10594) # Objective - Standardize fmt for toml files ## Solution - Add [taplo](https://taplo.tamasfe.dev/) to CI (check for fmt and diff for toml files), for context taplo is used by the most popular extension in VScode [Even Better TOML](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml - Add contribution section to explain toml fmt with taplo. Now to pass CI you need to run `taplo fmt --option indent_string=" "` or if you use vscode have the `Even Better TOML` extension with 4 spaces for indent --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
2023-11-21 01:04:14 +00:00
serde = { version = "1.0", features = ["derive"] }
update bitflags to 2.3 (#8728) # Objective - Update bitflags to 2.3
2023-06-01 08:41:42 +00:00
bitflags = "2.3"
Reference in a new issue Copy permalink