Skip to content

Commit

Permalink
Add Check Markdown Link GH action
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelSimons committed Aug 21, 2024
1 parent 6ff3bb0 commit 74eee94
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 6 deletions.
11 changes: 11 additions & 0 deletions .github/linters/.check-markdown-links.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"ignorePatterns": [
// 500
{
"pattern": "^https://packages.ubuntu.com/search?suite=default&section=all&arch=any&keywords=dotnet&searchon=names"
},
{
"pattern": "^https://github.com/dotnet/sdk/tree/main/src/SourceBuild/patches"
}
]
}
24 changes: 24 additions & 0 deletions .github/workflows/check-markdown-links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: 'Check Markdown Links'

on:
pull_request:
paths:
- "**/*.md"

permissions:
pull-requests: read

jobs:
check-markdown-links:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Check markdown links
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: .github/linters/.check-markdown-links.json
use-quiet-mode: 'yes'
use-verbose-mode: 'no'
6 changes: 3 additions & 3 deletions Documentation/VMR-re-bootstrapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,15 @@ re-bootstrap the VMR:
can try using an earlier passing build.
1. Retrieve the built SDK version from the build.
1. Update the dotnet version in the
[global.json](https://github.com/dotnet/installer/blob/main/src/SourceBuild/content/global.json).
[global.json](https://github.com/dotnet/sdk/blob/main/src/SourceBuild/content/global.json).
1. Update arcade
1. Lookup the arcade commit and version. From a VMR commit, you can find the
corresponding arcade commit/version by looking at the
[source-manifest.json](https://github.com/dotnet/dotnet/blob/main/src/source-manifest.json).
1. Update the arcade SDK version in the
[global.json](https://github.com/dotnet/installer/blob/main/src/SourceBuild/content/global.json).
[global.json](https://github.com/dotnet/sdk/blob/main/src/SourceBuild/content/global.json).
1. Update the arcade dependency commit and version in the
[Version.Details.xml](https://github.com/dotnet/installer/blob/main/src/SourceBuild/content/eng/Version.Details.xml).
[Version.Details.xml](https://github.com/dotnet/sdk/blob/main/src/SourceBuild/content/eng/Version.Details.xml).
1. Update private source-built SDK and artifacts versions
1. Update `PrivateSourceBuiltSdkVersion` and
`PrivateSourceBuiltArtifactsVersion` in the
Expand Down
3 changes: 1 addition & 2 deletions Documentation/planning/arcade-powered-source-build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,8 +214,7 @@ A: There are two reasons to make a patch:
[speculative-build.md]: speculative-build.md
[intermediate-nupkg.md]: intermediate-nupkg.md
[intermediate nupkgs]: intermediate-nupkg.md
[onboarding/local-onboarding.md#patching]:
onboarding/local-onboarding.md#patching
[onboarding/local-onboarding.md#patching]:onboarding/local-onboarding.md#patching

---

Expand Down
2 changes: 1 addition & 1 deletion Documentation/planning/multi-sdk-band-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ feature](https://github.com/dotnet/arcade/blob/main/Documentation/UnifiedBuild/V
functionality. Examples include
[runtime](https://github.com/dotnet/dotnet/tree/main/src/runtime),
[roslyn](https://github.com/dotnet/dotnet/tree/main/src/roslyn) or
[installer](https://github.com/dotnet/dotnet/tree/main/src/installer).
[sdk](https://github.com/dotnet/dotnet/tree/main/src/sdk).
- **Previously source-built (PSB)** - Artifacts from a previous
servicing/preview iteration, or from a bootstrap build. These may be used when
building the current dotnet VMR branch, but may not be bundled into any
Expand Down

0 comments on commit 74eee94

Please sign in to comment.