bevy/.github
François f8fa229465 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 75acb73040/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
..
contributing Clean up advice on glob imports in style guide (#4644) 2022-05-02 18:45:00 +00:00
example-run Add an example to test small window sizes (#3597) 2022-04-26 22:15:24 +00:00
ISSUE_TEMPLATE Make bug template more beginner-friendly (#4652) 2022-05-30 22:11:44 +00:00
linters Remove markdown dead link check (#4839) 2022-05-25 05:08:34 +00:00
start-wasm-example run examples in wasm in CI (#4818) 2022-06-06 20:22:51 +00:00
workflows Examples metadata in Cargo.toml (#4741) 2022-06-25 20:23:24 +00:00
bors.toml run examples in wasm in CI (#4818) 2022-06-06 20:22:51 +00:00
dependabot.yml dependabot: use new C-Dependencies label 2021-07-13 12:51:48 -07:00
FUNDING.yml Create FUNDING.yml 2020-08-18 10:59:30 -07:00
pull_request_template.md Let contributors know it's okay to delete optional template sections (#4498) 2022-04-16 18:57:51 +00:00