test: add a test to check for correct internal links, and fix them #4421
Conversation
This file contains 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
pb8o
added
Priority: Low
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4421 +/- ##
=======================================
Coverage 81.37% 81.37%
=======================================
Files 243 243
Lines 29518 29518
=======================================
Hits 24021 24021
Misses 5497 5497
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
pb8o
force-pushed
the
check-mdwn-internal-links
branch
from
95ebbcf
to
4f263f7
Compare
pb8o
added
Status: Awaiting review
|
Tagging the issue which was created for this: #4342 |
Because I would rather not introduce a new dependency if it doesn't buy us much. Checking for internal links is pretty simple. And checking for external links I think it should not be done as part of CI (we can sync on that offline). |
pb8o
force-pushed
the
check-mdwn-internal-links
branch
7 times, most recently
from
fca663f
to
a56e48e
Compare
roypat
previously approved these changes
Feb 14, 2024
pb8o
force-pushed
the
check-mdwn-internal-links
branch
3 times, most recently
from
9f82ee3
to
8f3253e
Compare
roypat
previously approved these changes
Feb 14, 2024
Add a helper function to only consider files in the repo. This helps if the local workspace has files coming from other sources, like the linux kernel, or uncommitted changes. Signed-off-by: Pablo Barbáchano <[email protected]>
Add a test to check that internal links in markdown files are correct. Also restrict both markdown tests to only check for files within the git repo. Signed-off-by: Pablo Barbáchano <[email protected]>
This helps when the workspace includes files not commited in the repo. Signed-off-by: Pablo Barbáchano <[email protected]>
This is convenient to add all the style checks locally Signed-off-by: Pablo Barbáchano <[email protected]>
pb8o
force-pushed
the
check-mdwn-internal-links
branch
from
2b34a7c
to
3307724
Compare
roypat
approved these changes
Feb 14, 2024
wearyzen
approved these changes
Feb 14, 2024
kalyazin
approved these changes
Feb 14, 2024
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.
Add a test to check that internal links in markdown files are correct.
Also restrict both markdown tests to only check for files within the git repo.
Changes
Reason
This should help internal and external contributors run style checks quickly, which is one of the DevEx pain points we currently have.
License Acceptance
By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following
Developer Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.PR Checklist
CHANGELOG.md.TODOs link to an issue.rust-vmm.