From 66fe1ca6c9d3c86887bccd2c550d92587f27b2da Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Jan 2025 08:28:00 -0700 Subject: [PATCH 1/3] Add markup link checker to GitHub workflow --- .github/workflows/build.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 5b4fc7be..2d951062 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -69,3 +69,13 @@ jobs: timeout-minutes: 3 continue-on-error: true if: env.codecov_token != '' + + docs: + name: 📃 Docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: 🔗 Markup Link Checker (mlc) + uses: becheran/mlc@v0.19.0 + with: + args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx From b3b3da2f87f080d451e7514865717c7cd6540ecd Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Jan 2025 08:35:34 -0700 Subject: [PATCH 2/3] Fix stale link in CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77f5e0a3..56dd666f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ You should install the version specified in `global.json` or a later version wit the same major.minor.Bxx "hundreds" band. For example if 2.2.300 is specified, you may install 2.2.300, 2.2.301, or 2.2.310 while the 2.2.400 version would not be considered compatible by .NET SDK. -See [.NET Core Versioning](https://docs.microsoft.com/dotnet/core/versions/) for more information. +See [.NET Core Versioning](https://learn.microsoft.com/dotnet/core/versions/) for more information. ## Package restore @@ -44,7 +44,7 @@ Building, testing, and packing this repository can be done by using the standard ## Releases Use `nbgv tag` to create a tag for a particular commit that you mean to release. -[Learn more about `nbgv` and its `tag` and `prepare-release` commands](https://github.com/dotnet/Nerdbank.GitVersioning/blob/main/doc/nbgv-cli.md). +[Learn more about `nbgv` and its `tag` and `prepare-release` commands](https://dotnet.github.io/Nerdbank.GitVersioning/docs/nbgv-cli.html). Push the tag. From 1da386324a06ce360c03270dd19c01133270c4c0 Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Mon, 27 Jan 2025 09:25:14 -0700 Subject: [PATCH 3/3] Skip aka.ms links that don't validate --- .github/workflows/docs_validate.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs_validate.yml b/.github/workflows/docs_validate.yml index 07dd8b9a..d1c8b8fb 100644 --- a/.github/workflows/docs_validate.yml +++ b/.github/workflows/docs_validate.yml @@ -6,7 +6,7 @@ on: jobs: build: - name: 📚 docfx + name: 📚 Doc validation runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 @@ -15,7 +15,7 @@ jobs: - name: 🔗 Markup Link Checker (mlc) uses: becheran/mlc@v0.19.0 with: - args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx + args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dev.azure.com/*,https://app.codecov.io/*,https://msrc.microsoft.com/*,https://www.microsoft.com/en-us/msrc* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://www.microsoft.com/msrc/cvd,https://www.microsoft.com/msrc - name: ⚙ Install prerequisites run: | ./init.ps1 -UpgradePrerequisites