Repository navigation
Add html-proofer link check for 4.x docs - #497
Merged
Merged
Conversation
dlmarion
approved these changes
Sep 29, 2026
dlmarion
left a comment
Contributor
There was a problem hiding this comment.
I don't have any experience with this, but the changes look benign to me.
DomGarguilo
marked this pull request as ready for review
September 29, 2026 18:12
Member
Author
|
Marking this as ready for review now. Once #495 is merged the failing checks will pass. This PR fixes ~50 errors from the tooling added. An example of what the new CI check looks like when it fails can be seen at 231e026. Here is a snippet from that failing check: That commit makes these issues fail the build instead of warn so it now catches the broken links that will be fixed as of the changes in #495 Update: the build passes after merging. 92132cd |
ctubbsii
reviewed
Oct 1, 2026
Co-authored-by: Christopher Tubbs <ctubbsii@apache.org>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds an internal link checker to the CI to make sure we are actively fixing any dead/broken links.
The config/setup for things to run in the CI was added in 980113f
Tooling added:
html-prooferadded to theGemfileRakefile: defines the task (namedlinkshere) which opens the built site (from_site/), checks all internal links against the files that actually exist, for now skips checks for everythign outside of thedocs/4.xdir, prints errors if there are anyHere are some resources I used to add this feature: