Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better link checker on CI (linkinator and lychee misses important things) #5925

Closed
emilk opened this issue Apr 11, 2024 · 3 comments · Fixed by #5986
Closed

Better link checker on CI (linkinator and lychee misses important things) #5925

emilk opened this issue Apr 11, 2024 · 3 comments · Fixed by #5986
Assignees
Labels
🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation 🚢 CI

Comments

@emilk
Copy link
Member

emilk commented Apr 11, 2024

Another example:
https://docs.rs/rerun/latest/rerun/trait.AsComponents.html links to https://github.com/rerun-io/rerun/blob/latest/examples/rust/custom_data/src/main.rs which is 404 - I've intentionally not fixed this link yet so we can check that the fixed link checker catches it

This makes me worried that we have a lot of broken links.

We need to either fix linkinator, or switch to a better tool.

@emilk emilk added 🪳 bug Something isn't working 🚢 CI labels Apr 11, 2024
@emilk emilk changed the title linkinator misses links Better link checker on CI (linkinator misses important things) Apr 12, 2024
@emilk emilk added the 📖 documentation Improvements or additions to documentation label Apr 12, 2024
@emilk
Copy link
Member Author

emilk commented Apr 12, 2024

We can try https://github.com/lycheeverse/lychee

@Wumpf Wumpf self-assigned this Apr 12, 2024
@Wumpf
Copy link
Member

Wumpf commented Apr 15, 2024

@Wumpf Wumpf closed this as completed Apr 15, 2024
@emilk
Copy link
Member Author

emilk commented Apr 16, 2024

The new link checker didn't catch the broken link to https://github.com/rerun-io/rerun/blob/latest/examples/rust/custom_data/src/main.rs which was part of the litmus test of this issue

@emilk emilk reopened this Apr 16, 2024
@emilk emilk changed the title Better link checker on CI (linkinator misses important things) Better link checker on CI (linkinator and lychee misses important things) Apr 16, 2024
Wumpf added a commit that referenced this issue Apr 16, 2024
### What

Code files are now included in link checking.

* Fixes #5925

Some issues encountered:
* globs don't respect exclude_files which makes working with this
locally harder lycheeverse/lychee#1405
* can't specify extensions / correct files aren't picked up
automatically lycheeverse/lychee#410

### 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/5986?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/5986?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/5986)
- [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`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation 🚢 CI
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants