[pull] master from nunit:master #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

pull wants to merge 739 commits into MichaelCorleoneLi:master from nunit:master

.claude/settings.local.json

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    {
+      "permissions": {
+        "allow": [
+          "Bash(dotnet build:*)",
+          "Bash(dotnet test:*)",
+          "Bash(docfx:*)",
+          "Bash(dir:*)",
+          "Bash(grep:*)"
+        ],
+        "deny": [],
+        "ask": []
+      }
+    }

.devcontainer/Dockerfile

-Original file line number
+Diff line change
@@ -1,103 +1,41 @@
-    FROM nunitdocs/docfx-action:v1.4.0
-    EXPOSE 8080
-    ### Installing Node into the container -- from https://github.com/nodejs/docker-node/tree/main/16/buster-slim
-    RUN groupadd --gid 1000 node \
-      && useradd --uid 1000 --gid node --shell /bin/bash --create-home node
-    ENV NODE_VERSION 16.7.0
-    RUN ARCH= && dpkgArch="$(dpkg --print-architecture)" \
-      && case "${dpkgArch##*-}" in \
-      amd64) ARCH='x64';; \
-      ppc64el) ARCH='ppc64le';; \
-      s390x) ARCH='s390x';; \
-      arm64) ARCH='arm64';; \
-      armhf) ARCH='armv7l';; \
-      i386) ARCH='x86';; \
-      *) echo "unsupported architecture"; exit 1 ;; \
-      esac \
-      && set -ex \
-      # libatomic1 for arm
-      && apt-get update && apt-get install -y ca-certificates curl wget gnupg dirmngr xz-utils libatomic1 --no-install-recommends \
-      && rm -rf /var/lib/apt/lists/* \
-      && for key in \
-ED778F539E3634C779C87C6D7062848A1AB005C \
-AE36675C464D64BAFA68DD7434390BDBE9B9C5 \
-F12602B6F1C4E913FAA37AD3A89613643B6201 \
-DCFD284A79C3B38668286BC97EC7A07EDE3FC1 \
-FCCA13FEF1D0C2E91008E09770F7A9A5AE15600 \
-      C4F0DFFF4E8C1A8236409D08E73BC641CC11F4C8 \
-      C82FA3AE1CBEDC6BE46B9360C43CEC45C17AB93C \
-      DD8F2338BAE7501E3DD5AC78C273792F7D83545D \
-      A48C2BEE680E841632CD4E44F07496B3EB3C1762 \
-F52B48DB57BB0CC439B2997B01419BD92F80A \
-      B9E2F5981AA6E0CD28160D9FF13993A75599653C \
-      ; do \
-      gpg --batch --keyserver hkps://keys.openpgp.org --recv-keys "$key" || \
-      gpg --batch --keyserver keyserver.ubuntu.com --recv-keys "$key" ; \
-      done \
-      && curl -fsSLO --compressed "https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION-linux-$ARCH.tar.xz" \
-      && curl -fsSLO --compressed "https://nodejs.org/dist/v$NODE_VERSION/SHASUMS256.txt.asc" \
-      && gpg --batch --decrypt --output SHASUMS256.txt SHASUMS256.txt.asc \
-      && grep " node-v$NODE_VERSION-linux-$ARCH.tar.xz\$" SHASUMS256.txt | sha256sum -c - \
-      && tar -xJf "node-v$NODE_VERSION-linux-$ARCH.tar.xz" -C /usr/local --strip-components=1 --no-same-owner \
-      && rm "node-v$NODE_VERSION-linux-$ARCH.tar.xz" SHASUMS256.txt.asc SHASUMS256.txt \
-      && apt-mark auto '.*' > /dev/null \
-      && find /usr/local -type f -executable -exec ldd '{}' ';' \
-      | awk '/=>/ { print $(NF-1) }' \
-      | sort -u \
-      | xargs -r dpkg-query --search \
-      | cut -d: -f1 \
-      | sort -u \
-      | xargs -r apt-mark manual \
-      && ln -s /usr/local/bin/node /usr/local/bin/nodejs \
-      # smoke tests
-      && node --version \
-      && npm --version
-    ENV YARN_VERSION 1.22.5
-    RUN set -ex \
-      && savedAptMark="$(apt-mark showmanual)" \
-      && apt-get update && apt-get install -y ca-certificates curl wget gnupg dirmngr --no-install-recommends \
-      && rm -rf /var/lib/apt/lists/* \
-      && for key in \
-A010C5166006599AA17F08146C2130DFD2497F5 \
-      ; do \
-      gpg --batch --keyserver hkps://keys.openpgp.org --recv-keys "$key" || \
-      gpg --batch --keyserver keyserver.ubuntu.com --recv-keys "$key" ; \
-      done \
-      && curl -fsSLO --compressed "https://yarnpkg.com/downloads/$YARN_VERSION/yarn-v$YARN_VERSION.tar.gz" \
-      && curl -fsSLO --compressed "https://yarnpkg.com/downloads/$YARN_VERSION/yarn-v$YARN_VERSION.tar.gz.asc" \
-      && gpg --batch --verify yarn-v$YARN_VERSION.tar.gz.asc yarn-v$YARN_VERSION.tar.gz \
-      && mkdir -p /opt \
-      && tar -xzf yarn-v$YARN_VERSION.tar.gz -C /opt/ \
-      && ln -s /opt/yarn-v$YARN_VERSION/bin/yarn /usr/local/bin/yarn \
-      && ln -s /opt/yarn-v$YARN_VERSION/bin/yarnpkg /usr/local/bin/yarnpkg \
-      && rm yarn-v$YARN_VERSION.tar.gz.asc yarn-v$YARN_VERSION.tar.gz \
-      && apt-mark auto '.*' > /dev/null \
-      && { [ -z "$savedAptMark" ] || apt-mark manual $savedAptMark > /dev/null; } \
-      && find /usr/local -type f -executable -exec ldd '{}' ';' \
-      | awk '/=>/ { print $(NF-1) }' \
-      | sort -u \
-      | xargs -r dpkg-query --search \
-      | cut -d: -f1 \
-      | sort -u \
-      | xargs -r apt-mark manual \
-      # smoke test
-      && yarn --version
-    ### Installing the relevant npm packages
-    RUN npm install -g npm
-    RUN npm install -g cspell
-    RUN npm install -g markdownlint-cli
-    ### Add the aliases
-    RUN echo 'alias spellcheck="cspell --config /workspaces/docs/cSpell.json \"/workspaces/docs/docs/**/*.md\""' >> ~/.bashrc
-    RUN echo 'alias lint="markdownlint -c /workspaces/docs/.github/linters/.markdown-lint.yml /workspaces/docs/docs/**/*.md"' >> ~/.bashrc
-    RUN echo 'alias build="cd /workspaces/docs/docs && docfx build"' >> ~/.bashrc
-    RUN echo 'alias serve="build && docfx serve _site -n \"*\""' >> ~/.bashrc
+    FROM ghcr.io/nunit/docfx-action:v4.1.0
+    EXPOSE 8080
+    ARG NODE_MAJOR=20
+    ### Installing Node LTS into the container
+    RUN apt-get update
+    RUN apt-get install -y ca-certificates curl gnupg
+    RUN mkdir -p /etc/apt/keyrings
+    RUN curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
+    RUN echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list
+    RUN apt-get update
+    RUN apt-get install nodejs unzip dos2unix -y
+    ### Installing Node Packages
+    RUN npm install -g yarn
+    RUN npm install -g npm
+    RUN npm install -g cspell
+    RUN npm install -g markdownlint-cli2
+    RUN node -v
+    RUN npm -v
+    RUN yarn -v
+    # This script gets the api-docs from the latest NUnit release
+    COPY get-nunit-apidocs.sh .
+    RUN dos2unix ./get-nunit-apidocs.sh
+    RUN chmod +x get-nunit-apidocs.sh
+    ### Add the aliases
+    # We get the first workspace, because there should only be one
+    # This is so that when someone updates their devcontainer name, it doesn't get screwed up
+    RUN echo 'first_workspace=\"$(cd /workspaces && ls | head -1)\"; alias spellcheck="cspell --config /workspaces/$first_workspace/cSpell.json \"/workspaces/$first_workspace/docs/**/*.md\" --no-progress"' >> ~/.bashrc
+    RUN echo 'first_workspace=\"$(cd /workspaces && ls | head -1)\"; alias lint="markdownlint-cli2 --config /workspaces/$first_workspace/.github/linters/.markdownlint.yml /workspaces/$first_workspace/docs/**/*.md"' >> ~/.bashrc
+    RUN echo 'first_workspace=\"$(cd /workspaces && ls | head -1)\"; alias build="docfx /workspaces/$first_workspace/docs/docfx.json"' >> ~/.bashrc
+    RUN echo 'first_workspace=\"$(cd /workspaces && ls | head -1)\"; alias serve="docfx /workspaces/$first_workspace/docs/docfx.json --serve"' >> ~/.bashrc
+    RUN echo 'first_workspace=\"$(cd /workspaces && ls | head -1)\"; alias snippets="dotnet test /workspaces/$first_workspace/docs/snippets/Snippets.sln"' >> ~/.bashrc
+    # We load the latest NUnit apidocs at start in case they're needed later
+    RUN echo 'alias apidocs="bash /get-nunit-apidocs.sh"' >> ~/.bashrc
+    RUN echo 'apidocs' >> ~/.bashrc

.devcontainer/devcontainer.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -4,12 +4,22 @@ @@
             "dockerfile": "Dockerfile"
         },
         "forwardPorts": [8080],
-        "extensions": [
-            "streetsidesoftware.code-spell-checker",
-            "oderwat.indent-rainbow",
-            "mdickin.markdown-shortcuts",
-            "davidanson.vscode-markdownlint",
-            "redhat.vscode-yaml",
-            "vsls-contrib.codetour"
-        ]
+    	"customizations": {
+    		"vscode": {
+    			"extensions": [
+    				"streetsidesoftware.code-spell-checker",
+    				"oderwat.indent-rainbow",
+    				"mdickin.markdown-shortcuts",
+    				"davidanson.vscode-markdownlint",
+    				"redhat.vscode-yaml",
+    				"vsls-contrib.codetour",
+    				"GitHub.vscode-pull-request-github",
+    				"shuworks.vscode-table-formatter",
+    				"ms-dotnettools.csharp",
+    				"github.vscode-github-actions",
+    				"ms-azuretools.vscode-docker",
+    				"stkb.rewrap"
+    			]
+    		}
+    	}
     }

.devcontainer/get-nunit-apidocs.sh

-Original file line number
+Diff line change
@@ -0,0 +1,15 @@
+    # This script gets the the latest version of NUnit and extracts it. This is because docfx is capable of generating API docs, and this way the Codespace will be automatically enabled to do that.
+    # This is hard-coded for now.
+    NUNIT_VERSION_FOR_API_DOCS="4.3.2"
+    first_workspace="$(cd /workspaces && ls | head -1)"
+    wget "https://github.com/nunit/nunit/releases/download/$NUNIT_VERSION_FOR_API_DOCS/NUnit.Framework-$NUNIT_VERSION_FOR_API_DOCS.zip" -O /apidocs.zip
+    mkdir -p /workspaces/$first_workspace/code-output
+    unzip -o /apidocs.zip -d /apidocs
+    cp -r /apidocs/bin/net8.0/* /workspaces/$first_workspace/code-output
+    rm -rf /apidocs.zip
+    rm -rf /apidocs

.github/linters/.markdown-lint.yml → .github/linters/.markdownlint.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -22,6 +22,8 @@ MD024: false @@
     MD013: false
     MD026: false
     MD046: false # Mix of indented and fenced code blocks
+    MD004: false
+    MD060: false
     # MD004: false                  # Unordered list style
     # MD007:
     #   indent: 2                   # Unordered list indentation
@@ Expand Down @@

.github/workflows/build-process.yml

-Original file line number
+Diff line change
@@ -1,72 +1,108 @@
-    name: NUnit Documentation Build Process
-    on:
-      push:
-        branches:
-          - master
-      pull_request:
-        branches:
-          - master
-    jobs:
-      linting:
-        name: "Markdown linting"
-        runs-on: ubuntu-latest
-        steps:
-          - uses: actions/checkout@v2
-            name: Check out the code
-          - name: Lint Code Base
-            uses: docker://avtodev/markdown-lint:v1
-            with:
-              args: "docs/**/*.md"
-      spellcheck:
-        name: "Spell check"
-        runs-on: ubuntu-latest
-        steps:
-          - uses: actions/checkout@v2
-            name: Check out the code
-          - uses: actions/setup-node@v1
-            name: Setup node
-            with:
-              node-version: "12"
-          - run: npm install -g cspell
-            name: Install cSpell
-          - run: cspell --config ./cSpell.json "docs/**/*.md"
-            name: run cSpell
-      build:
-        name: "Build the site with docfx"
-        runs-on: ubuntu-latest
-        steps:
-          - uses: actions/checkout@v2
-            name: Check out the code
-          - uses: "nunit/docfx-action@v1.5.0"
-            name: Build with Docfx
-            with:
-              args: docs/docfx.json --warningsAsErrors true
-          - name: zip site contents
-            run: zip -r _site.zip docs/_site/
-          - name: Archive site artifacts
-            uses: actions/upload-artifact@v2
-            with:
-              name: siteArtifact
-              path: _site.zip
-      publish:
-        name: Publish (master branch only)
-        needs: [linting, spellcheck, build]
-        runs-on: ubuntu-latest
-        if: ${{ github.ref == 'refs/heads/master'}}
-        steps:
-          - name: Download site artifacts
-            uses: actions/download-artifact@v2
-            with:
-              name: siteArtifact
-          - name: unzip site contents
-            run: unzip _site.zip
-          - name: Push to gh-pages branch (master only)
-            if: ${{ github.ref == 'refs/heads/master'}}
-            uses: peaceiris/actions-gh-pages@v3
-            with:
-              commit_message: ${{ github.event.head_commit.message }}
-              github_token: ${{ secrets.GITHUB_TOKEN }}
-              publish_dir: ./docs/_site
-              publish_branch: gh-pages
+    name: NUnit Documentation Build Process
+    on:
+      push:
+        branches:
+          - master
+      pull_request:
+        branches:
+          - master
+    env:
+      NUNIT_VERSION_FOR_API_DOCS: "4.4.0"
+    jobs:
+      linting:
+        name: "Markdown linting"
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v6
+            name: Check out the code
+          - uses: actions/setup-node@v6
+            name: Setup node
+            with:
+              node-version: "24"
+          - run: npm install -g markdownlint-cli2
+            name: Install markdownlint-cli2
+          - run: markdownlint-cli2 --config ".github/linters/.markdownlint.yml" "docs/**/*.md"
+            name: run Markdownlint
+      spellcheck:
+        name: "Spell check"
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v6
+            name: Check out the code
+          - uses: actions/setup-node@v6
+            name: Setup node
+            with:
+              node-version: "24"
+          - run: npm install -g cspell
+            name: Install cSpell
+          - run: cspell --config ./cSpell.json "docs/**/*.md" --no-progress
+            name: run cSpell
+      build:
+        name: "Build the site with docfx"
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v6
+            name: Check out the code
+          - name: Get latest NUnit Asset dir
+            uses: dsaltares/fetch-gh-release-asset@master
+            with:
+              repo: 'nunit/nunit'
+              version: 'tags/${{ env.NUNIT_VERSION_FOR_API_DOCS }}'
+              file: 'NUnit.Framework-${{ env.NUNIT_VERSION_FOR_API_DOCS }}.zip'
+              token: ${{ secrets.GITHUB_TOKEN }}
+          - name: Unzip NUnit Asset zip file into its own directory
+            run: unzip NUnit.Framework-${{ env.NUNIT_VERSION_FOR_API_DOCS }}.zip -d ./NUnit.Framework-${{ env.NUNIT_VERSION_FOR_API_DOCS }}
+          - name: Copy NUnit Asset dir
+            run: mkdir ./code-output && cp -r ./NUnit.Framework-${{ env.NUNIT_VERSION_FOR_API_DOCS }}/bin/net8.0/* ./code-output
+          - uses: "nunit/docfx-action@v4.1.0"
+            name: Build with Docfx
+            with:
+              args: docs/docfx.json --warningsAsErrors true
+          - name: zip site contents
+            run: zip -r _site.zip docs/_site/
+          - name: Archive site artifacts
+            uses: actions/upload-artifact@v6
+            with:
+              name: siteArtifact
+              path: _site.zip
+      snippets:
+        name: "Build/Test Snippets"
+        runs-on: ubuntu-latest
+        env:
+          SOLUTION_LOCATION: "./docs/snippets/Snippets.sln"
+        steps:
+          - name: Check out the code
+            uses: actions/checkout@v6
+          - name: Setup .NET
+            uses: actions/setup-dotnet@v5
+            with:
+              dotnet-version: 10.x
+          - name: Restore dependencies
+            run: dotnet restore $SOLUTION_LOCATION
+          - name: Build
+            run: dotnet build --no-restore $SOLUTION_LOCATION
+          - name: Test
+            run: dotnet test --no-build --verbosity normal $SOLUTION_LOCATION
+      publish:
+        name: Publish (master branch only)
+        needs: [linting, spellcheck, build, snippets]
+        runs-on: ubuntu-latest
+        if: ${{ github.ref == 'refs/heads/master'}}
+        steps:
+          - name: Download site artifacts
+            uses: actions/download-artifact@v7
+            with:
+              name: siteArtifact
+          - name: unzip site contents
+            run: unzip _site.zip
+          - name: Push to gh-pages branch (master only)
+            if: ${{ github.ref == 'refs/heads/master'}}
+            uses: peaceiris/actions-gh-pages@v4
+            with:
+              commit_message: ${{ github.event.head_commit.message }}
+              github_token: ${{ secrets.GITHUB_TOKEN }}
+              publish_dir: ./docs/_site
+              publish_branch: gh-pages

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[pull] master from nunit:master #41

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!

[pull] master from nunit:master #41

Are you sure you want to change the base?

Uh oh!

[pull] master from nunit:master #41

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!