bevy/.github/bors.toml at b399a374cb407ac94aaeb6755c06b9a3a559ec6a - Mirrors/bevy - CherryKitten

Mirrors/bevy

mirror of https://github.com/bevyengine/bevy synced 2024-11-10 07:04:33 +00:00

FlyingRatBull b399a374cb 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

15 lines

378 B

TOML

Raw Blame History

 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",
 ]
 use_squash_merge = true