forked from rerun-io/rerun
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replace linkinator with lychee (rerun-io#5969)
### What Use https://github.com/lycheeverse/lychee instead of Linkinator and fix a bunch of links. Advantages of lychee: * can run locally easily, config is an easy to read file and not on the ci job * finds a bunch of links linkinator missed * caches successful links for a while Unfortunately, there's no conda package, so I couldn't make this a pixi task. But this is rarely needed to run locally and the install instructions are simple. ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested the web demo (if applicable): * Using examples from latest `main` build: [rerun.io/viewer](https://rerun.io/viewer/pr/5969?manifest_url=https://app.rerun.io/version/main/examples_manifest.json) * Using full set of examples from `nightly` build: [rerun.io/viewer](https://rerun.io/viewer/pr/5969?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json) * [x] The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG * [x] If applicable, add a new check to the [release checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)! - [PR Build Summary](https://build.rerun.io/pr/5969) - [Recent benchmark results](https://build.rerun.io/graphs/crates.html) - [Wasm size tracking](https://build.rerun.io/graphs/sizes.html) To run all checks from `main`, comment on the PR with `@rerun-bot full-check`.
- Loading branch information
Showing
9 changed files
with
528 additions
and
319 deletions.
There are no files selected for viewing
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
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
This file was deleted.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -152,3 +152,27 @@ jobs: | |
|
|
||
| - name: prettier --check | ||
| run: pixi run misc-fmt-check | ||
|
|
||
| # --------------------------------------------------------------------------- | ||
|
|
||
| link-checker: | ||
| name: Check links | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Restore link checker cache | ||
| uses: actions/cache@v3 | ||
| with: | ||
| path: .lycheecache | ||
| key: cache-lychee-${{ github.sha }} | ||
| restore-keys: cache-lychee- | ||
|
|
||
| # Check https://github.com/lycheeverse/lychee on how to run locally. | ||
| - name: Link Checker | ||
| id: lychee | ||
| uses: lycheeverse/[email protected] | ||
| with: | ||
| fail: true | ||
| lycheeVersion: "0.14.3" | ||
| args: "--base . --cache --max-cache-age 1d ." | ||
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| ################################################################################ | ||
| # Config for the link checker lychee. | ||
| # | ||
| # Download & learn more at: | ||
| # https://github.com/lycheeverse/lychee | ||
| # | ||
| # Example config: | ||
| # https://github.com/lycheeverse/lychee/blob/master/lychee.example.toml | ||
| # | ||
| # Run `lychee . --dump` to list all found links that are being checked. | ||
| ################################################################################ | ||
|
|
||
| # Maximum number of concurrent link checks. | ||
| # Workaround for "too many open files" error on MacOS, see https://github.com/lycheeverse/lychee/issues/1248 | ||
| max_concurrency = 32 | ||
|
|
||
|
|
||
| # URLs to check (supports regex). Has preference over all excludes. | ||
| exclude_path = [ | ||
| # Unfortunately lychee doesn't yet read .gitignore https://github.com/lycheeverse/lychee/issues/1331 | ||
| # The following entries are there because of that: | ||
| "__pycache__", | ||
| "_deps/", | ||
| ".pixi", | ||
| "build", | ||
| "docs/python/", | ||
| "rerun_cpp/docs/html", | ||
| "rerun_cpp/docs/xml", | ||
| "rerun_py/site/", | ||
| "target_ra", | ||
| "target_wasm", | ||
| "target", | ||
| "rerun_cpp/tmp/", | ||
|
|
||
| # Actually ignored files beyond .gitignore | ||
| "scripts/screenshot_compare/assets/templates/", | ||
| ] | ||
|
|
||
| # Exclude URLs and mail addresses from checking (supports regex). | ||
| exclude = [ | ||
| '.*?speculative-link', # Skip speculative links | ||
| '.github/workflows/.*.yml', # GitHub action workflows cause issues on CI. | ||
| '\$relpath\^', # Relative paths as used by rerun_cpp's doc header. | ||
| '%7B%7B.+%7D%7D', # Ignore things that look like links because of `href` but are actually replacement strings. The URL escaping is for '{{.+}}' (this seems to be needed for html embedded urls since lychee assumes they use this encoding). | ||
| 'https://crates.io/crates/.*', # Avoid crates.io rate-limiting | ||
| 'https://cs.nyu.edu/~silberman/datasets/nyu_depth_v2.html', # Nyud links are down every now and then. | ||
| 'https://eigen.tuxfamily.org/', # Website down https://gitlab.com/libeigen/eigen/-/issues/2804 | ||
| 'https://fonts.googleapis.com/', # Font API entrypoint, not a link. | ||
| 'https://fonts.gstatic.com/', # Font API entrypoint, not a link. | ||
| 'https://github.com/rerun-io/rerun/pull/\.*', # Ignore links to our own pull requests (typically in changelog). | ||
| 'https://github.com/rerun-io/rerun/commit/\.*', # Ignore links to our own commits (typically in changelog). | ||
| 'https://stackoverflow.com/.', # Stackoverflow links are no longer accessible from CI. | ||
| 'https://www.tensorflow.org/', # tensorflow.org apparently blocks CI. | ||
|
|
||
| # Works but is really slow at times: | ||
| 'https://openaccess.thecvf.com/content/CVPR2023/html/Du_Learning_To_Render_Novel_Views_From_Wide-Baseline_Stereo_Pairs_CVPR_2023_paper.html', | ||
| 'https://anaconda.org/conda-forge/arrow-cpp', | ||
|
|
||
| #'^file:///', # Ignore local file links. They need to be tested, but it's useful for external links we have to ping. | ||
| ] |
Oops, something went wrong.