Add weekly linkchecker and report failures on issue#3792
Open
melissawm wants to merge 1 commit intoAI-Hypercomputer:mainfrom
Open
Add weekly linkchecker and report failures on issue#3792melissawm wants to merge 1 commit intoAI-Hypercomputer:mainfrom
melissawm wants to merge 1 commit intoAI-Hypercomputer:mainfrom
Conversation
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.
Description
Currently, we perform a full link check (for external URLs) on every CI run, which:
This PR changes the link checker to only run once a week (on mondays) and to report any failures as an issue to the MaxText repo.
As a note, the internal links (those referencing documents within the MaxText docs folder) are automatically checked during the docs build. The current docs build does NOT fail on warnings (including broken internal links), but it should, and this will be fixed in a subsequent PR.
The link checker can also be run manually from the repo Actions tab.
Tests
To see what this would look like, I have implemented this fully on my fork of MaxText. You can see the action run here: https://github.com/melissawm/maxtext/actions/runs/25226702400
Note it has failed (as expected) and the generated issue with the failure report is here: melissawm#2
Checklist
Before submitting this PR, please make sure (put X in square brackets):
gemini-reviewlabel.