mirror of
https://github.com/bevyengine/bevy
synced 2024-11-26 22:50:19 +00:00
b399a374cb
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 ```
21 lines
370 B
JSON
21 lines
370 B
JSON
{
|
|
"ignorePatterns": [
|
|
{
|
|
"pattern": "^https?://github\\.com/"
|
|
}
|
|
],
|
|
"replacementPatterns": [],
|
|
"httpHeaders": [
|
|
{
|
|
"urls": ["https://crates.io"],
|
|
"headers": {
|
|
"Accept": "text/html"
|
|
}
|
|
}
|
|
],
|
|
"timeout": "20s",
|
|
"retryOn429": true,
|
|
"retryCount": 5,
|
|
"fallbackRetryDelay": "30s",
|
|
"aliveStatusCodes": [200, 206]
|
|
}
|