From 991512bddfa428f4c4ccb7c47158dc2e1f91ca04 Mon Sep 17 00:00:00 2001 From: Michael Simons Date: Wed, 21 Aug 2024 16:43:20 -0500 Subject: [PATCH] Add Check Markdown Link GH action --- .github/linters/.check-markdown-links.json | 11 +++++++++ .github/workflows/check-markdown-links.yml | 24 +++++++++++++++++++ Documentation/VMR-re-bootstrapping.md | 6 ++--- .../arcade-powered-source-build/README.md | 3 +-- .../planning/multi-sdk-band-support.md | 2 +- 5 files changed, 40 insertions(+), 6 deletions(-) create mode 100644 .github/linters/.check-markdown-links.json create mode 100644 .github/workflows/check-markdown-links.yml diff --git a/.github/linters/.check-markdown-links.json b/.github/linters/.check-markdown-links.json new file mode 100644 index 0000000000..2575578804 --- /dev/null +++ b/.github/linters/.check-markdown-links.json @@ -0,0 +1,11 @@ +{ + "ignorePatterns": [ + { + "pattern": "^https://packages.ubuntu.com/search?suite=default§ion=all&arch=any&keywords=dotnet&searchon=names" + }, + { + "pattern": "https://github.com/dotnet/sdk/tree/main/src/SourceBuild/patches" + } + ], + "aliveStatusCodes": [200, 203] +} diff --git a/.github/workflows/check-markdown-links.yml b/.github/workflows/check-markdown-links.yml new file mode 100644 index 0000000000..225f3ed838 --- /dev/null +++ b/.github/workflows/check-markdown-links.yml @@ -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' diff --git a/Documentation/VMR-re-bootstrapping.md b/Documentation/VMR-re-bootstrapping.md index b904138024..c84070a46e 100644 --- a/Documentation/VMR-re-bootstrapping.md +++ b/Documentation/VMR-re-bootstrapping.md @@ -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 diff --git a/Documentation/planning/arcade-powered-source-build/README.md b/Documentation/planning/arcade-powered-source-build/README.md index 5f73d472ed..1a68d58015 100644 --- a/Documentation/planning/arcade-powered-source-build/README.md +++ b/Documentation/planning/arcade-powered-source-build/README.md @@ -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 --- diff --git a/Documentation/planning/multi-sdk-band-support.md b/Documentation/planning/multi-sdk-band-support.md index 5619d8b1ec..4ba9b3653f 100644 --- a/Documentation/planning/multi-sdk-band-support.md +++ b/Documentation/planning/multi-sdk-band-support.md @@ -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