Repository navigation
gha: add an advisory check of external links a PR adds - #542
Draft
JakeSCahill wants to merge 1 commit into
Draft
JakeSCahill wants to merge 1 commit into
JakeSCahill wants to merge 1 commit into
Conversation
|
Commits Review LGTM |
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.
Adds a
link-checkjob to test.yml that runs on pull requests. It calls the reusable pr-link-check.yml from docs-extensions-and-macros, which checks the external URLs a PR adds in non-test Go files. 404 and 410 get a warning annotation at the file and line, and other failures are listed as couldn't check in the job summary. It never fails the PR, needs no secrets, and only hascontents: readandpull-requests: read.This catches dead doc-string links on the PR instead of in the weekly docs-site link check after merge (redpanda-data/docs-site#291).
The workflow is pinned to a commit on redpanda-data/docs-extensions-and-macros#440. Once that PR merges, re-pin to the merge or release SHA, the same way connect pins connect-docs-check.yml.
Dry run of the script on #510's diff: it finds the two added w3.org multipart URLs in output_http_client.go and processor_http.go (w3.org answers 403, so they're listed as couldn't check). On #524 it finds none, since every added URL there is in a test file or a comment.