ci: Add ci check for broken URLs#15141
Merged
MoritzThomasHuebner merged 19 commits intomagma:masterfrom Mar 17, 2023
Merged
Conversation
pull-request-size
bot
added
the
size/L
Contributor
|
Thanks for opening a PR! 💯
Howto
More infoPlease take a moment to read through the Magma project's
If this is your first Magma PR, also consider reading
|
github-actions
bot
added
component: ci
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
MoritzThomasHuebner
force-pushed
the
add_ci_check_for_broken_links
branch
2 times, most recently
from
e810bb1 to
46b992a
Compare
Contributor
|
Oops! Looks like you failed the Howto
♻️ Updated: ✅ The check is passing the Docs Lint & Check Generated Files In Sync after the last commit. |
MoritzThomasHuebner
force-pushed
the
add_ci_check_for_broken_links
branch
6 times, most recently
from
2521619 to
74663d3
Compare
LKreutzer
reviewed
Mar 13, 2023
| runs-on: ubuntu-20.04 | ||
| steps: | ||
| - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # [email protected] | ||
| - uses: gaurav-nelson/github-action-markdown-link-check@5c5dfc0ac2e225883c0e5f03a85311ec2830d368 # pin@v1 |
Contributor
There was a problem hiding this comment.
Nit: Perhaps it would be better to use d53a906aa6b22b8979d33bc86170567e619495ec/1.0.15 ?
Contributor
There was a problem hiding this comment.
Currently there are some warnings, I think we might get rid of them with the new version.
Contributor
Author
There was a problem hiding this comment.
Yeah looks like the new version does not produce these errors anymore
| - uses: gaurav-nelson/github-action-markdown-link-check@5c5dfc0ac2e225883c0e5f03a85311ec2830d368 # pin@v1 | ||
| with: | ||
| use-verbose-mode: 'yes' | ||
| config-file: '.github/workflows/markdown_link_check_config.json' |
Contributor
There was a problem hiding this comment.
I think the config file should be moved to .github/workflows/config/
Signed-off-by: Sebastian Wolf <[email protected]>
Signed-off-by: Sebastian Wolf <[email protected]>
Signed-off-by: Sebastian Wolf <[email protected]>
Signed-off-by: Sebastian Wolf <[email protected]>
Signed-off-by: Sebastian Wolf <[email protected]>
Signed-off-by: Sebastian Wolf <[email protected]>
Signed-off-by: Sebastian Wolf <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
MoritzThomasHuebner
force-pushed
the
add_ci_check_for_broken_links
branch
from
1ee4b87 to
69e3a09
Compare
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]>
MoritzThomasHuebner
force-pushed
the
add_ci_check_for_broken_links
branch
from
2232233 to
7959b98
Compare
LKreutzer
approved these changes
Mar 15, 2023
lucasgonze
pushed a commit
to lucasgonze/magma
that referenced
this pull request
Feb 29, 2024
* docs: remove dead links in kubectl commands (v1.7) Signed-off-by: Sebastian Wolf <[email protected]> * docs: fix link to black (v1.5 and v1.6) Signed-off-by: Sebastian Wolf <[email protected]> * docs: replace archived fb github link Signed-off-by: Sebastian Wolf <[email protected]> * docs: replace dead wemake-python link with github repo link Signed-off-by: Sebastian Wolf <[email protected]> * docs: update thanos storage link in p002 Signed-off-by: Sebastian Wolf <[email protected]> * docs: update links to new artifactory Signed-off-by: Sebastian Wolf <[email protected]> * docs: update dead facebookincubator links to magma Signed-off-by: Sebastian Wolf <[email protected]> * docs: Fixed a number of dead links Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * docs: Fixed a broken link Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * docs: Removed some weird underscores Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * docs: Added missing "https" for consistency Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * docs: Fixed a typo Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * docs: Added workflow for broken URLs Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * docs: Replace uber link Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * ci: Moved markdown link check config file Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * ci: Increased markdown link check version Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * ci: Fixed a path to a config file Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * ci: Testing workflow Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> * ci: Added another url exception Co-authored-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> --------- Signed-off-by: Sebastian Wolf <[email protected]> Signed-off-by: Moritz Huebner <[email protected]> Co-authored-by: Sebastian Wolf <[email protected]>
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
3 participants
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.
Closes #14962
Merge after #15121
Summary
gaurav-nelson/github-action-markdown-link-checkworkflow to run on markdown files withingdocs/.http.markdown-link-checkdoes not correctly check these URLs.localhost,127.0.0.1, etc.Question: Should this also run on markdown files outside
docs/? There is no way to exclude symbolic links so many files may be scanned twice.Test Plan
In #15121 we fixed most broken links already. I used markdown-link-check and a self written script to scrape for URLs. Otherwise we only want to see that the test is green.