Skip to content

Commit 60021d1

Browse files
Add Check Markdown Link GH action (#4570)
1 parent 6ff3bb0 commit 60021d1

File tree

7 files changed

+51
-38
lines changed

7 files changed

+51
-38
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"ignorePatterns": [
3+
{
4+
"pattern": "^https://github.com/dotnet/sdk/tree/main/src/SourceBuild/patches"
5+
},
6+
{
7+
"pattern": "^https://dotnetcli.blob.core.windows.net/source-built-artifacts/sdks/"
8+
},
9+
{
10+
"pattern": "^https://dotnetcli.blob.core.windows.net/source-built-artifacts/assets/"
11+
},
12+
{
13+
"pattern": "^https://www.reddit.com/r/archlinux/comments/cx64r5/the_state_of_net_core_on_arch/"
14+
}
15+
],
16+
"aliveStatusCodes": [200, 203]
17+
}
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: 'Check Markdown Links'
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "**/*.md"
7+
8+
permissions:
9+
pull-requests: read
10+
11+
jobs:
12+
check-markdown-links:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v4
18+
19+
- name: Check markdown links
20+
uses: gaurav-nelson/github-action-markdown-link-check@v1
21+
with:
22+
config-file: .github/linters/.check-markdown-links.json
23+
use-quiet-mode: 'yes'
24+
use-verbose-mode: 'no'

Documentation/VMR-re-bootstrapping.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,19 +82,19 @@ re-bootstrap the VMR:
8282
can try using an earlier passing build.
8383
1. Retrieve the built SDK version from the build.
8484
1. Update the dotnet version in the
85-
[global.json](https://github.com/dotnet/installer/blob/main/src/SourceBuild/content/global.json).
85+
[global.json](https://github.com/dotnet/sdk/blob/main/src/SourceBuild/content/global.json).
8686
1. Update arcade
8787
1. Lookup the arcade commit and version. From a VMR commit, you can find the
8888
corresponding arcade commit/version by looking at the
8989
[source-manifest.json](https://github.com/dotnet/dotnet/blob/main/src/source-manifest.json).
9090
1. Update the arcade SDK version in the
91-
[global.json](https://github.com/dotnet/installer/blob/main/src/SourceBuild/content/global.json).
91+
[global.json](https://github.com/dotnet/sdk/blob/main/src/SourceBuild/content/global.json).
9292
1. Update the arcade dependency commit and version in the
93-
[Version.Details.xml](https://github.com/dotnet/installer/blob/main/src/SourceBuild/content/eng/Version.Details.xml).
93+
[Version.Details.xml](https://github.com/dotnet/sdk/blob/main/src/SourceBuild/content/eng/Version.Details.xml).
9494
1. Update private source-built SDK and artifacts versions
9595
1. Update `PrivateSourceBuiltSdkVersion` and
9696
`PrivateSourceBuiltArtifactsVersion` in the
97-
[Versions.props](https://github.com/dotnet/installer/blob/main/src/SourceBuild/content/eng/Versions.props).
97+
[Versions.props](https://github.com/dotnet/sdk/blob/main/src/SourceBuild/content/eng/Versions.props).
9898

9999
[Tracking issue for automating this
100100
process.](https://github.com/dotnet/source-build/issues/4246)

Documentation/planning/arcade-powered-source-build/README.md

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,7 @@ ArPow consists of two main goals with some key benefits:
5151
has to root-cause and patch over problems.
5252

5353
* Gives us a place to add additional source-build-specific tests for common
54-
problems, such as [nongranular servicing
55-
readiness](../nongranular-servicing-readiness) and (most critically)
56-
prebuilt usage regressions.
54+
problems, such as prebuilt usage regressions.
5755

5856
This doc is about where we can start, what incremental progress would look like,
5957
and the vision.
@@ -183,39 +181,13 @@ compatible with source-build requirements, and if validation runs into a
183181
problem, they are able to reproduce the build locally using an Arcade build
184182
command.
185183

186-
---
187-
188-
## Q&A
189-
190-
### Q: How do we patch without an orchestration-focused repo?
191-
192-
A: There are two reasons to make a patch:
193-
194-
1. The repository doesn't properly build from source, and it will take a long
195-
time to figure out a fix that works both in source-build and in the
196-
Microsoft build. The practical solution is to put a `.patch` file into the
197-
repo itself that is only applied during a build from source.
198-
* See [onboarding/local-onboarding.md#patching]
199-
200-
2. The repository successfully builds from source in its local build and
201-
official build, but doesn't work when built inside a tarball. This *should*
202-
be considered a build break, and be fixed in the repository directly. The
203-
fix then flows down to dotnet/installer to produce a fixed tarball. However,
204-
release deadlines may prevent this.
205-
* The dotnet/installer build process may need a way to inject a `.patch`
206-
file into the tarball. The `.patch` file would be checked into
207-
dotnet/installer and copied into the output tarball. This reduces the
208-
scope of a build reset.
209-
210184
[in-arcade.md]: in-arcade.md
211185
[incremental-official-chunked.md]: incremental-official-chunked.md
212186
[incremental-official.md]: incremental-official.md
213187
[source-build-in-pipeline.md]: source-build-in-pipeline.md
214188
[speculative-build.md]: speculative-build.md
215189
[intermediate-nupkg.md]: intermediate-nupkg.md
216190
[intermediate nupkgs]: intermediate-nupkg.md
217-
[onboarding/local-onboarding.md#patching]:
218-
onboarding/local-onboarding.md#patching
219191

220192
---
221193

Documentation/planning/multi-sdk-band-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ feature](https://github.com/dotnet/arcade/blob/main/Documentation/UnifiedBuild/V
2323
functionality. Examples include
2424
[runtime](https://github.com/dotnet/dotnet/tree/main/src/runtime),
2525
[roslyn](https://github.com/dotnet/dotnet/tree/main/src/roslyn) or
26-
[installer](https://github.com/dotnet/dotnet/tree/main/src/installer).
26+
[sdk](https://github.com/dotnet/dotnet/tree/main/src/sdk).
2727
- **Previously source-built (PSB)** - Artifacts from a previous
2828
servicing/preview iteration, or from a bootstrap build. These may be used when
2929
building the current dotnet VMR branch, but may not be bundled into any

Documentation/sourcebuild-in-repos/new-repo.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ These changes are all needed before source build will work:
2424
List of allowed prebuilts (approval required).
2525
* [`eng/Version.Details.xml`](#engversiondetailsxml) - Already exists, but
2626
modifications are needed to pull dependencies from upstream [intermediate
27-
nupkgs](planning/arcade-powered-source-build/README.md#intermediate-nupkg-outputsinputs).
27+
nupkgs](../planning/arcade-powered-source-build/README.md#intermediate-nupkg-outputsinputs).
2828

2929
See the following sections for details:
3030

@@ -162,7 +162,7 @@ elements, and adding a new `source-build-reference-packages` element.
162162
[intermediate nupkg]s from the upstream repo's official build, rather than using
163163
prebuilt binaries to fulfill the dependencies. Note that `RepoName` is used to
164164
calculate the ID of the [intermediate
165-
nupkg](planning/arcade-powered-source-build/README.md#intermediate-nupkg-outputsinputs):
165+
nupkg](../planning/arcade-powered-source-build/README.md#intermediate-nupkg-outputsinputs):
166166
the `Dependency` `Name` is ignored by source build.
167167

168168
Building with the source-built versions of your dependencies also means that any
@@ -172,7 +172,7 @@ where your source build depends on an upstream component that isn't actually
172172
built in source build.
173173

174174
`ManagedOnly` determines whether a RID suffix is necessary on the [intermediate
175-
nupkg](planning/arcade-powered-source-build/README.md#intermediate-nupkg-outputsinputs)
175+
nupkg](../planning/arcade-powered-source-build/README.md#intermediate-nupkg-outputsinputs)
176176
ID. For example, running source build on `dotnet/installer` with `linux-x64`
177177
with the above example configuration will restore:
178178

Documentation/system-requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ a targeted platform.
2222
MacOS is not currently supported: [Tracking
2323
Issue](https://github.com/dotnet/source-build/issues/2909). However, community
2424
users have created a [Homebrew
25-
project](https://github.com/Homebrew/homebrew-core/blob/master/Formula/dotnet.rb)
25+
project](https://github.com/Homebrew/homebrew-core/blob/master/Formula/d/dotnet.rb)
2626
to build .NET for OSX. Please feel free to open new issues in individual repos
2727
or in source-build for OSX issues.
2828

0 commit comments

Comments
 (0)