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 22, 2024
1 parent 6ff3bb0 commit 495c548
Show file tree
Hide file tree
Showing 7 changed files with 56 additions and 14 deletions.
20 changes: 20 additions & 0 deletions .github/linters/.check-markdown-links.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"ignorePatterns": [
{
"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"
},
{
"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]
}
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'
8 changes: 4 additions & 4 deletions Documentation/VMR-re-bootstrapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,19 +82,19 @@ 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
[Versions.props](https://github.com/dotnet/installer/blob/main/src/SourceBuild/content/eng/Versions.props).
[Versions.props](https://github.com/dotnet/sdk/blob/main/src/SourceBuild/content/eng/Versions.props).

[Tracking issue for automating this
process.](https://github.com/dotnet/source-build/issues/4246)
8 changes: 3 additions & 5 deletions Documentation/planning/arcade-powered-source-build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,7 @@ ArPow consists of two main goals with some key benefits:
has to root-cause and patch over problems.

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

This doc is about where we can start, what incremental progress would look like,
and the vision.
Expand All @@ -75,6 +73,7 @@ There are a few key parts of the infrastructure to prototype:
The official build and PR validation build pipelines work, with a reasonable API
for other repositories to adopt.

[foo](#intermediate-nupkg-outputsinputs)
* [source-build-in-pipeline.md]

### Intermediate nupkg outputs/inputs
Expand Down Expand Up @@ -214,8 +213,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
6 changes: 3 additions & 3 deletions Documentation/sourcebuild-in-repos/new-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ These changes are all needed before source build will work:
List of allowed prebuilts (approval required).
* [`eng/Version.Details.xml`](#engversiondetailsxml) - Already exists, but
modifications are needed to pull dependencies from upstream [intermediate
nupkgs](planning/arcade-powered-source-build/README.md#intermediate-nupkg-outputsinputs).
nupskgs](../planning/arcade-powered-source-build/README.md#intermediate-nupkg-outputsinputs).

See the following sections for details:

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion Documentation/system-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ a targeted platform.
MacOS is not currently supported: [Tracking
Issue](https://github.com/dotnet/source-build/issues/2909). However, community
users have created a [Homebrew
project](https://github.com/Homebrew/homebrew-core/blob/master/Formula/dotnet.rb)
project](https://github.com/Homebrew/homebrew-core/blob/master/Formula/d/dotnet.rb)
to build .NET for OSX. Please feel free to open new issues in individual repos
or in source-build for OSX issues.

Expand Down

0 comments on commit 495c548

Please sign in to comment.