mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 07:04:33 +00:00
44f64a32f4
Closes #1581 # Internal File/Link Consistency checker Action This pull request adds an action to the CI that parses the [`./examples`](https://github.com/bevyengine/bevy/tree/main/examples) folder for files and cross references that with the links listed in [`README.md`](https://github.com/bevyengine/bevy/blob/main/examples/README.md) and [`Cargo.toml`](https://github.com/bevyengine/bevy/blob/main/Cargo.toml) to ensure the documentation actually reflects the examples currently in the repo. The primary reason for why we want this, is to prevent people from adding new examples but forgetting to also list them in the docs, or accidentally entering broken links (typos in docs). For details on how the action is working: [Check out the README here](https://github.com/Weibye/action-internal-link-consistency/blob/main/README.md) Co-authored-by: Andreas Weibye <13300393+Weibye@users.noreply.github.com>
16 lines
416 B
TOML
16 lines
416 B
TOML
status = [
|
|
"build (stable, windows-latest)",
|
|
"build (stable, ubuntu-latest)",
|
|
"build (stable, macos-latest)",
|
|
"build (nightly, ubuntu-latest)",
|
|
"build-wasm (stable, ubuntu-latest)",
|
|
"build-wasm (nightly, ubuntu-latest)",
|
|
"build-android",
|
|
"markdownlint",
|
|
"check-markdown-links",
|
|
"run-examples",
|
|
"check-doc",
|
|
"check-missing-examples-in-docs",
|
|
]
|
|
|
|
use_squash_merge = true
|