Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-10 07:04:33 +00:00
Code Issues Projects Releases Packages Wiki Activity
bevy/.github/bors.toml

18 lines
463 B
TOML
Raw Normal View History

Bors (#1482) * Time to do the bors tango
2021-02-19 21:15:29 +00:00
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)",
Cleanup of Markdown Files and add CI Checking (#1463) I have run the VSCode Extension [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) on all Markdown Files in the Repo. The provided Rules are documented here: https://github.com/DavidAnson/markdownlint/blob/v0.23.1/doc/Rules.md Rules I didn't follow/fix: * MD024/no-duplicate-heading * Changelog: Here Heading will always repeat. * Examples Readme: Platform-specific documentation should be symmetrical. * MD025/single-title * MD026/no-trailing-punctuation * Caused by the ! in "Hello, World!". * MD033/no-inline-html * The plugins_guidlines file does need HTML, so the shown badges aren't downscaled too much. * ~~MD036/no-emphasis-as-heading:~~ * ~~This Warning only Appears in the Github Issue Templates and can be ignored.~~ * ~~MD041/first-line-heading~~ * ~~Only appears in the Readme for the AlienCake example Assets, which is unimportant.~~ --- I also sorted the Examples in the Readme and Cargo.toml in this order/Priority: * Topic/Folder * Introductionary Examples * Alphabetical Order The explanation for each case, where it isn't Alphabetical : * Diagnostics * log_diagnostics: The usage of inbuild Diagnostics is more important than creating your own. * ECS (Entity Component System) * ecs_guide: The guide should be read, before diving into other Features. * Reflection * reflection: Basic Explanation should be read, before more advanced Topics. * WASM Examples * hello_wasm: It's "Hello, World!".
2021-02-22 04:50:05 +00:00
"markdownlint",
GitHub Action: Check local Markdown links on push (#2067) Adds an GitHub Action to check all local (non http://, https:// ) links in all Markdown files of the repository for liveness. Fails if a file is not found. # Goal This should help maintaining the quality of the documentation. # Impact Takes ~24 seconds currently and found 3 dead links (pull requests already created). # Dependent PRs * #2064 * #2065 * #2066 # Info See [markdown-link-check](https://github.com/marketplace/actions/markdown-link-check). # Example output ``` FILE: ./docs/profiling.md 1 links checked. FILE: ./docs/plugins_guidelines.md 37 links checked. FILE: ./docs/linters.md [✖] ../.github/linters/markdown-lint.yml → Status: 400 [Error: ENOENT: no such file or directory, access '/github/workspace/.github/linters/markdown-lint.yml'] { errno: -2, code: 'ENOENT', syscall: 'access', path: '/github/workspace/.github/linters/markdown-lint.yml' } ``` # Improvements * Can also be used to check external links, but fails because of: * Too many requests (429) responses: ``` FILE: ./CHANGELOG.md [✖] https://github.com/bevyengine/bevy/pull/1762 → Status: 429 ``` * crates.io links respond 404 ``` FILE: ./README.md [✖] https://crates.io/crates/bevy → Status: 404 ```
2021-05-02 20:22:32 +00:00
"check-markdown-links",
add new ci job for examples to bors (#1928) followup on https://github.com/bevyengine/bevy/pull/1826#issuecomment-819874735: adding the new job to Bors
2021-04-15 00:16:42 +00:00
"run-examples",
Fail CI on cargo doc warnings (#2012) * makes CI fails on cargo doc warnings * adds this check in bors doc warnings are listed here: https://doc.rust-lang.org/rustdoc/lints.html Currently the warnings emitted are: * broken_intra_doc_links * private_intra_doc_links * invalid_codeblock_attributes
2021-04-27 02:17:12 +00:00
"check-doc",
CI - Check that examples are listed in README and Cargo (#1650) 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>
2021-05-30 18:14:58 +00:00
"check-missing-examples-in-docs",
add check for unused dependencies (#2461) # Objective - Unused dependencies are bad ## Solution - Add check for unused dependencies with https://github.com/est31/cargo-udeps - #2455
2021-07-16 01:38:41 +00:00
"check-unused-dependencies",
Bors (#1482) * Time to do the bors tango
2021-02-19 21:15:29 +00:00
]
use_squash_merge = true
Relicense bors checks (#2493) # Objective Currently we can sometimes allow PRs by people who haven't agreed to the relicense to get merged into main. E.g. https://github.com/bevyengine/bevy/pull/2445 ## Solution This adds a check to ensure that this doesn't happen, by ensuring that bors doesn't relicense said PRs. As a bonus, it also adds config to automatically label new PRs as needing checking, to ensure that we do the verification until we merge the new license.
2021-07-17 18:56:56 +00:00
block_labels = ["S-Pre-Relicense"]
Reference in a new issue Copy permalink