From 91afbb5f88251bc5f7567e57dc6c134d358926a8 Mon Sep 17 00:00:00 2001 From: "Jeremy D. Miller" Date: Mon, 5 Oct 2026 18:36:40 -0500 Subject: [PATCH] GH-794: docs-prs.yml builds the docs the way docs.yml does The job targeted master (the default branch is main), so it never ran, and its last step called a Nuke target that doesn't exist. It now runs on PRs to main that touch the docs and builds them with mdsnippets + npm run docs-build. The markdownlint and cSpell steps are dropped: there is no lint config, the docs/cSpell.json it pointed at doesn't exist, and today's docs fail markdownlint's defaults 1,700 times. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01J8KxC18Q51z5w4u6YARwe4 --- .github/workflows/docs-prs.yml | 49 ++++++++----------- .../targets-smoke/dupes_dedupe_off.csproj | 6 +-- .../temp/targets-smoke/dupes_dedupe_on.csproj | 6 +-- .nuke/temp/targets-smoke/no_analyzers.csproj | 2 +- .../targets-smoke/required_and_present.csproj | 4 +- .../targets-smoke/required_but_absent.csproj | 2 +- .nuke/temp/targets-smoke/single_copy.csproj | 4 +- 7 files changed, 33 insertions(+), 40 deletions(-) diff --git a/.github/workflows/docs-prs.yml b/.github/workflows/docs-prs.yml index c6bdb08a..86a0b369 100644 --- a/.github/workflows/docs-prs.yml +++ b/.github/workflows/docs-prs.yml @@ -1,52 +1,45 @@ name: Documentation PRs on: - push: - branches: - - master pull_request: branches: - - master + - main + paths: + - 'docs/**' + - 'package.json' + - 'package-lock.json' + - 'mdsnippets.json' + - '.github/workflows/docs-prs.yml' env: DOTNET_CLI_TELEMETRY_OPTOUT: 1 DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1 - node_version: 20.x - NUKE_TELEMETRY_OPTOUT: true + node_version: 24.x jobs: run: - name: "linting, spell check and build" + name: "build docs" runs-on: ubuntu-latest steps: - uses: actions/checkout@v7 name: Check out the code - - name: Lint Code Base - uses: docker://ghcr.io/igorshubovych/markdownlint-cli:latest - with: - args: "--disable MD009 -- docs/**/*.md" - - - uses: actions/setup-node@v7 - name: Install Node.js + - name: Install .NET 10.0.x + uses: actions/setup-dotnet@v6 with: - node-version: ${{ env.node_version }} - - - run: npm install -g cspell - name: Install cSpell + dotnet-version: 10.0.x - - run: cspell --config ./docs/cSpell.json "docs/**/*.md" - name: run cSpell + - name: Install mdsnippets + run: dotnet tool install -g MarkdownSnippets.Tool - - name: Install .NET 9.0.x - uses: actions/setup-dotnet@v6 + - name: Setup Node.js + uses: actions/setup-node@v7 with: - dotnet-version: 9.0.x + node-version: ${{ env.node_version }} + cache: npm - - name: Install .NET 10.0.x - uses: actions/setup-dotnet@v6 - with: - dotnet-version: 10.0.x + - name: Install dependencies + run: npm ci - name: Build docs - run: ./build.sh docs-build \ No newline at end of file + run: npm run docs-build diff --git a/.nuke/temp/targets-smoke/dupes_dedupe_off.csproj b/.nuke/temp/targets-smoke/dupes_dedupe_off.csproj index fb6a71fe..634998f8 100644 --- a/.nuke/temp/targets-smoke/dupes_dedupe_off.csproj +++ b/.nuke/temp/targets-smoke/dupes_dedupe_off.csproj @@ -3,8 +3,8 @@ false - - + + - + diff --git a/.nuke/temp/targets-smoke/dupes_dedupe_on.csproj b/.nuke/temp/targets-smoke/dupes_dedupe_on.csproj index cf4684eb..4fc33a51 100644 --- a/.nuke/temp/targets-smoke/dupes_dedupe_on.csproj +++ b/.nuke/temp/targets-smoke/dupes_dedupe_on.csproj @@ -3,8 +3,8 @@ - - + + - + diff --git a/.nuke/temp/targets-smoke/no_analyzers.csproj b/.nuke/temp/targets-smoke/no_analyzers.csproj index e139478a..39dc3078 100644 --- a/.nuke/temp/targets-smoke/no_analyzers.csproj +++ b/.nuke/temp/targets-smoke/no_analyzers.csproj @@ -5,5 +5,5 @@ - + diff --git a/.nuke/temp/targets-smoke/required_and_present.csproj b/.nuke/temp/targets-smoke/required_and_present.csproj index 1db2010b..861d6eef 100644 --- a/.nuke/temp/targets-smoke/required_and_present.csproj +++ b/.nuke/temp/targets-smoke/required_and_present.csproj @@ -3,7 +3,7 @@ true - + - + diff --git a/.nuke/temp/targets-smoke/required_but_absent.csproj b/.nuke/temp/targets-smoke/required_but_absent.csproj index 9da95faf..a9e0220c 100644 --- a/.nuke/temp/targets-smoke/required_but_absent.csproj +++ b/.nuke/temp/targets-smoke/required_but_absent.csproj @@ -5,5 +5,5 @@ - + diff --git a/.nuke/temp/targets-smoke/single_copy.csproj b/.nuke/temp/targets-smoke/single_copy.csproj index 9c537ac3..208c9680 100644 --- a/.nuke/temp/targets-smoke/single_copy.csproj +++ b/.nuke/temp/targets-smoke/single_copy.csproj @@ -3,7 +3,7 @@ false - + - +