-
Notifications
You must be signed in to change notification settings - Fork 528
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
Make linkcheck2 detection automatic #2181
Conversation
CC: @camelid |
Sorry, due to me messing up a git operation, we sadly had to force-push the whole commit history of rustc-dev-guide :( If you'd like to update this pull request, you will have to rebase it in a special way onto the new commit history (the new
More context can be found here. |
b0904f8
to
2aa0212
Compare
When I don't have the mdbook-linkcheck2 and try to run
I assume that is not expected? |
The RenderContext message is unrelated to mdbook-linkcheck2 and linkchecking in general AFAICT. I'm not sure why it's happening, but note that it's a warning not an error. The command still finishes successfully. |
Sorry, I didn't notice that, the "Error" in the warning message threw me off :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I lean against doing this change for a couple of reasons:
- Binary detection can lead to weird inconsistencies where different environments lead to different behaviors. E.g. one person may have linkcheck2 installed for use in other projects but another doesn't, and it will be confusing if their build behaves differently.
- Running linkchecking wastes a bit of your time and network resources locally (especially for people who have bad internet). Since it's run in CI anyway, it seems unnecessary to also run it by default locally (for people who already have the binary).
- Nearly all of the time new links you're adding are going to be correct because you just copy and paste them. Links usually only break over time.
- It's not much of a hassle to add
ENABLE_LINKCHECK=1
locally if you want it.
Works for me! |
No description provided.