Home page

Author: bradwilson

.config/dotnet-tools.json

@@ -0,0 +1,13 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "docfx": {
+      "version": "2.78.3",
+      "commands": [
+        "docfx"
+      ],
+      "rollForward": false
+    }
+  }
+}

.editorconfig

@@ -0,0 +1,12 @@
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf
+
+[*.cs]
+indent_style = tab
+indent_size = 4

.github/workflows/push-gh-pages-new.yml

@@ -0,0 +1,53 @@
+name: Pages build
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone source
+        uses: actions/checkout@v4
+
+      - name: Install .NET SDK
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: |
+            9.0.x
+
+      - name: Get .NET information
+        run: dotnet --info
+
+      - name: Setup GitHub Pages
+        uses: actions/configure-pages@v5
+
+      - name: "Build target: Build"
+        run: dotnet run --project tools/builder --no-launch-profile -- Build --timing
+
+      - name: "Upload artifact: github-pages"
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: .site/
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,4 +1,4 @@
-_site/
+.site/
 node_modules/
 bin/
 obj/

.vscode/launch.json

@@ -0,0 +1,3 @@
+{
+  "version": "0.2.0"
+}

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "cSpell.words": [
+        "parallelization",
+        "trippable"
+    ],
+    "editor.tabSize": 2,
+}

.vscode/tasks.json

@@ -0,0 +1,59 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Build",
+      "type": "process",
+      "command": "dotnet",
+      "args": [
+        "run",
+        "--project",
+        "tools/builder",
+        "--no-launch-profile",
+      ],
+      "options": {
+        "cwd": "${workspaceRoot}"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "presentation": {
+        "focus": true,
+      },
+      "problemMatcher": "$msCompile"
+    },
+    {
+      "label": "Serve",
+      "type": "process",
+      "command": "dotnet",
+      "args": [
+        "run",
+        "--project",
+        "tools/builder",
+        "--no-launch-profile",
+        "--",
+        "serve",
+      ],
+      "options": {
+        "cwd": "${workspaceRoot}"
+      },
+      "group": {
+        "kind": "build"
+      },
+      "presentation": {
+        "focus": false,
+      },
+      "isBackground": true,
+      "problemMatcher": [
+        {
+          "base": "$msCompile",
+          "background": {
+            "beginsPattern": "Restoring build environment",
+            "endsPattern": "clean exit - waiting for changes before restart"
+          },
+        }
+      ],
+    },
+  ]
+}

CNAME

@@ -0,0 +1 @@
+new.xunit.net

README.md

@@ -0,0 +1,40 @@
+# About This Project
+
+This project contains the public site for [https://xunit.net/](https://xunit.net/).
+
+To open an issue for this project, please visit the [core xUnit.net project issue tracker](https://github.com/xunit/xunit/issues).
+
+## Building and Contribution
+
+This site is built with Jekyll, which is based on Ruby, as this is the default system used by GitHub Pages. We use a C#-based build system.
+
+### Build prerequisites
+
+In order to successfully build and view the content locally, you will need the following pre-requisites:
+
+* [.NET SDK 9 or later](https://dotnet.microsoft.com/download/dotnet/)
+* [NodeJS 22 or later](https://nodejs.org/)
+
+### Editing the site pages
+
+The site content lives in [`/site`](https://github.com/xunit/xunit.net/tree/main/site) and the output will placed in `/.site`. To build the static content, run the command `./build` from the root of your clone, via your command prompt (bash and PowerShell are supported). This will do a one-time transformation of the templates in `/site` to the static files in `/.site`.
+
+For working interactively, you can run `./build serve` which will start Jekyll in a mode where it incrementally builds the site as needed, and will rebuild pages as you change the files. You can point your browser to [http://localhost:4000/](http://localhost:4000/) while the server is running to view the rendered content. Once you're finished, you can press Ctrl+C in the command prompt and the server will shut down.
+
+_Note: if you see a warning about `Auto-regeneration may not work on some Windows versions` and you're running in WSL 2, you may safely ignore this. Auto-regeneration works in WSL 2 without issue, and the warning is based on some very early WSL 1 bugs with file system watchers._
+
+Text editors/IDEs which understand site hierarchy and linking while editing Markdown and HTML are strongly encouraged to open the `/site` folder and not the root folder when editing content, so that the editor understands where the content root lives. _For example, if you're using VSCode, you should run `code site` and not `code .` from the root of the repo._ You should only ever need to open the root of the repo in your editor if you're working on the build tools.
+
+### Editing analyzer rule documentation
+
+The analyzer rules are does as Markdown templates that live in [`/site/xunit.analyzers/_rules`](site/xunit.analyzers/_rules) and are rendered dynamically into [`/site/xunit.analyzers/_rules`](site/xunit.analyzers/rules).
+
+The standard template for creating documentation for a new rule lives in [`/site/xunit.analyzers/_rules/_stub.md`](site/xunit.analyzers/_rules/_stub.md). Copy this file and name it to match the analyzer ID (note: these are case-sensitive, so they should always have names like `xUnit0000.md` where `0000` is the rule number). Fill out the document header and contents, and ensure the rule shows up in the [Analyzer Rules](http://localhost:4000/xunit.analyzers/rules) home page. Ensure that the page renders properly, as you may need to quote values in the header if they contain characters that Jekyll does not to process when running the template engine. You can use an existing documentation page to understand what an analyzer documentation page should look like.
+
+# About xUnit.net
+
+[<img align="right" src="https://xunit.net/images/dotnet-fdn-logo.png" width="100" />](https://www.dotnetfoundation.org/)
+
+xUnit.net is a free, open source, community-focused unit testing tool for the .NET Framework. Written by the original inventor of NUnit v2, xUnit.net is the latest technology for unit testing C#, F#, VB.NET and other .NET languages. xUnit.net works with ReSharper, CodeRush, TestDriven.NET and Xamarin. It is part of the [.NET Foundation](https://www.dotnetfoundation.org/), and operates under their [code of conduct](https://dotnetfoundation.org/about/policies/code-of-conduct). It is licensed under [Apache 2](https://opensource.org/licenses/Apache-2.0) (an OSI approved license).
+
+For project documentation, please visit the [xUnit.net project home](https://xunit.net/).

build

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+function write_error {
+	echo "error(1): $1" 2>&1
+	exit 1
+}
+
+function guard_bin {
+	builtin type -P "$1" &>/dev/null || write_error "Could not find '$1'; $2"
+}
+
+guard_bin git "please install the Git CLI from https://git-scm.com/"
+guard_bin dotnet "please install the .NET SDK from https://dot.net/"
+guard_bin node "please install NodeJS from https://nodejs.org/"
+
+[ $(dotnet --version | cut -d. -f1) -ge 9 ] || write_error ".NET SDK version $(dotnet --version) is too low; please install version 9.0 from https://dot.net/"
+
+git submodule status | while read line; do
+	if [ "$(echo $line | cut -b1)" == "-" ]; then
+		pieces=( $line )
+		git submodule update --init ${pieces[1]}
+		echo ""
+	fi
+done
+
+PUSHED=0
+
+cleanup () {
+	if [[ $PUSHED == 1 ]]; then
+		popd >/dev/null
+		PUSHED=0
+	fi
+}
+
+trap cleanup EXIT ERR INT TERM
+
+pushd $( cd "$(dirname "$0")" ; pwd -P ) >/dev/null
+PUSHED=1
+
+dotnet run --project tools/builder --no-launch-profile -- "$@"