From 32eba6193321d55181176b8a73900034d0177d11 Mon Sep 17 00:00:00 2001 From: Michael Simons Date: Thu, 3 Oct 2024 10:51:45 -0500 Subject: [PATCH 1/5] Switch to using linkspector for validating markdown links --- .github/linters/.check-markdown-links.json | 17 ----------------- .github/linters/.linkspector.yml | 14 ++++++++++++++ .github/workflows/check-markdown-links.yml | 8 ++++---- 3 files changed, 18 insertions(+), 21 deletions(-) delete mode 100644 .github/linters/.check-markdown-links.json create mode 100644 .github/linters/.linkspector.yml diff --git a/.github/linters/.check-markdown-links.json b/.github/linters/.check-markdown-links.json deleted file mode 100644 index 1b7736d014..0000000000 --- a/.github/linters/.check-markdown-links.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "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/" - } - ], - "aliveStatusCodes": [200, 203] -} diff --git a/.github/linters/.linkspector.yml b/.github/linters/.linkspector.yml new file mode 100644 index 0000000000..17f823fd87 --- /dev/null +++ b/.github/linters/.linkspector.yml @@ -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 diff --git a/.github/workflows/check-markdown-links.yml b/.github/workflows/check-markdown-links.yml index 225f3ed838..681caf354a 100644 --- a/.github/workflows/check-markdown-links.yml +++ b/.github/workflows/check-markdown-links.yml @@ -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 From a1f6a0323398498f9a0f72eff0ab72abbba4a252 Mon Sep 17 00:00:00 2001 From: Michael Simons Date: Thu, 3 Oct 2024 10:54:13 -0500 Subject: [PATCH 2/5] Test change to trigger linkspector --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 69c946e898..ff613373ab 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # .NET Source-Build +Test + Please use [GitHub discussions](https://github.com/dotnet/source-build/discussions) to see announcements, ask questions, make suggestions, and share information with other From bf3cbee0ef6596b99508addd90c29195a4774afd Mon Sep 17 00:00:00 2001 From: Michael Simons Date: Thu, 3 Oct 2024 11:04:03 -0500 Subject: [PATCH 3/5] Workaround invalid link --- Documentation/sourcebuild-in-repos/build-info.md | 2 +- Documentation/sourcebuild-in-repos/update-dependencies.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/sourcebuild-in-repos/build-info.md b/Documentation/sourcebuild-in-repos/build-info.md index b8087c3135..9151fc13fc 100644 --- a/Documentation/sourcebuild-in-repos/build-info.md +++ b/Documentation/sourcebuild-in-repos/build-info.md @@ -3,7 +3,7 @@ This is a collection of notes about how source-build can differ in general from your repo's build and what kind of issues that can create. -## Single-version and single-RID build +## Single version and single RID build Source-build is required to build on a single machine with no internet access. This means that we build targeting a single RID, usually the non-portable RID diff --git a/Documentation/sourcebuild-in-repos/update-dependencies.md b/Documentation/sourcebuild-in-repos/update-dependencies.md index b5a8414c6e..26e4ea3e76 100644 --- a/Documentation/sourcebuild-in-repos/update-dependencies.md +++ b/Documentation/sourcebuild-in-repos/update-dependencies.md @@ -42,7 +42,7 @@ what can happen is 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 + archive](build-info.md#Single_version_and_single_RID_build), 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. From be6f5b2c50ba0df7de52908fc0e8ecd6150081a3 Mon Sep 17 00:00:00 2001 From: Michael Simons Date: Thu, 3 Oct 2024 11:08:15 -0500 Subject: [PATCH 4/5] Workaround invalid link --- Documentation/sourcebuild-in-repos/update-dependencies.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Documentation/sourcebuild-in-repos/update-dependencies.md b/Documentation/sourcebuild-in-repos/update-dependencies.md index 26e4ea3e76..f67008e3c2 100644 --- a/Documentation/sourcebuild-in-repos/update-dependencies.md +++ b/Documentation/sourcebuild-in-repos/update-dependencies.md @@ -41,8 +41,7 @@ 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 + [previously-source-built archive](build-info.md#single-version-and-single-rid-build), 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. From d99d45c648f79bd98dbb0244bf1d54a1a7b6b756 Mon Sep 17 00:00:00 2001 From: Michael Simons Date: Thu, 3 Oct 2024 15:54:35 -0500 Subject: [PATCH 5/5] Workaround invalid link --- .github/linters/.markdown-lint.yml | 1 + Documentation/sourcebuild-in-repos/build-info.md | 2 +- Documentation/sourcebuild-in-repos/update-dependencies.md | 4 ++-- README.md | 2 -- 4 files changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml index 767b122e56..dcbc943f0d 100644 --- a/.github/linters/.markdown-lint.yml +++ b/.github/linters/.markdown-lint.yml @@ -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 diff --git a/Documentation/sourcebuild-in-repos/build-info.md b/Documentation/sourcebuild-in-repos/build-info.md index 9151fc13fc..b8087c3135 100644 --- a/Documentation/sourcebuild-in-repos/build-info.md +++ b/Documentation/sourcebuild-in-repos/build-info.md @@ -3,7 +3,7 @@ This is a collection of notes about how source-build can differ in general from your repo's build and what kind of issues that can create. -## Single version and single RID build +## Single-version and single-RID build Source-build is required to build on a single machine with no internet access. This means that we build targeting a single RID, usually the non-portable RID diff --git a/Documentation/sourcebuild-in-repos/update-dependencies.md b/Documentation/sourcebuild-in-repos/update-dependencies.md index f67008e3c2..a1b5fbea96 100644 --- a/Documentation/sourcebuild-in-repos/update-dependencies.md +++ b/Documentation/sourcebuild-in-repos/update-dependencies.md @@ -41,8 +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), + 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. diff --git a/README.md b/README.md index ff613373ab..69c946e898 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # .NET Source-Build -Test - Please use [GitHub discussions](https://github.com/dotnet/source-build/discussions) to see announcements, ask questions, make suggestions, and share information with other