Updated READMEs for the examples - Batch 1 #10238
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Markdown spellcheck and link check | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - "main" | |
| permissions: | |
| contents: read | |
| jobs: | |
| # BEWARE(streetsidesoftware/cspell-action#187): a misconfigured cspell will _not_ have a non-zero exit code… | |
| spellcheck: | |
| name: Spellcheck | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: streetsidesoftware/cspell-action@v3 | |
| with: | |
| config: "docs/cspell.json" | |
| files: "**/*.md" | |
| strict: true | |
| incremental_files_only: false | |
| linkinator: | |
| name: linkinator | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: jprochazk/linkinator-action@main | |
| with: | |
| # This list of file extensions matches the one in `scripts/lint.py`, except .html is omitted due to relative links. | |
| paths: "**/*.c, **/*.cpp, **/*.fbs, **/*.h, **/*.hpp, **/*.js, **/*.md, **/*.py, **/*.rs, **/*.sh, **/*.toml, **/*.txt, **/*.wgsl, **/*.yml" | |
| # Exceptions: | |
| # * avoid crates.io rate-limiting | |
| # * skip changelog PR links (so many) | |
| # * skip speculative links | |
| # * Stackoverflow links are no longer accessible from CI. | |
| # * Tuxfamily.org links are down intermittently. | |
| # * Nyud links are down every now and then. | |
| # * TODO(#4085): https://rerun-io.github.io/rerun/dev/bench/ often 404:s for unknown reasons | |
| # * TODO(#4556): remove the `static.rerun.io` and `github.com` skips | |
| linksToSkip: "https://stackoverflow.com/.*, https://eigen.tuxfamily.org/, https://cs.nyu.edu/~silberman/datasets/nyu_depth_v2.html, https://static.rerun.io/.*, https://github.com/.*, https://crates.io/crates/.*, https://github.com/rerun-io/rerun/pull/.*, .*?speculative-link, https://rerun-io.github.io/rerun/dev/bench/" | |
| retry: true | |
| retryErrors: true | |
| retryErrorsCount: 5 | |
| retryErrorsJitter: 2000 |