Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to using linkspector for validating markdown links #4643

Merged
merged 5 commits into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions .github/linters/.check-markdown-links.json

This file was deleted.

14 changes: 14 additions & 0 deletions .github/linters/.linkspector.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
aliveStatusCodes:
- 200
- 406
dirs:
- .
- .github
excludedDirs:
- eng/readme-templates
ignorePatterns:
- pattern: "^https://github.com/dotnet/sdk/tree/main/src/SourceBuild/patches"
- pattern: "^https://dotnetcli.blob.core.windows.net/source-built-artifacts/sdks/"
- pattern: "^https://dotnetcli.blob.core.windows.net/source-built-artifacts/assets/"
- pattern: "^https://www.reddit.com/r/archlinux/comments/cx64r5/the_state_of_net_core_on_arch/"
useGitIgnore: true
1 change: 1 addition & 0 deletions .github/linters/.markdown-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ default: true
MD013: # line length
code_block_line_length: 256
heading_line_length: 96
line_length: 96
MD033: false # no inline HTML
8 changes: 4 additions & 4 deletions .github/workflows/check-markdown-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ jobs:
uses: actions/checkout@v4

- name: Check markdown links
uses: gaurav-nelson/github-action-markdown-link-check@v1
uses: umbrelladocs/action-linkspector@v1
with:
config-file: .github/linters/.check-markdown-links.json
use-quiet-mode: 'yes'
use-verbose-mode: 'no'
config_file: .github/linters/.linkspector.yml
fail_on_error: true
filter_mode: nofilter
5 changes: 2 additions & 3 deletions Documentation/sourcebuild-in-repos/update-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,8 @@ what can happen is
1. In version 2, Package A is split into Package A1 and Package A2.
1. A downstream repo is never updated to take the split packages.
1. The version 2 source-build succeeds because Package A exists in the
[previously-source-built
archive](build-info.md#Single-version_and_single-RID_build), but no new
version of Package A is produced.
[previously-source-built archive](build-info.md#single-version-and-single-rid-build),
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

linkspector didn't like that the linked text was spread across multiple lines.

but no new version of Package A is produced.
1. Source-build version 3 fails because Package A no longer exists in the
previously-source-built archive either.

Expand Down