Pack as a .NET CLI tool

.github/workflows/build.yml

@@ -0,0 +1,56 @@
+name: Build
+
+on:
+  push:
+    branches: [ main, master, dev/** ]
+  pull_request:
+    branches: [ main, master ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/master' }}
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        configuration: [Release, Debug]
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Replace PackageId and PackageVersion in mdoc.csproj
+      shell: pwsh
+      run: |
+        $csprojPath = "mdoc/mdoc.csproj"
+        $content = Get-Content $csprojPath -Raw
+        $content = $content -replace '<PackageId>mdoc</PackageId>', '<PackageId>notmdoc</PackageId>'
+        $content = $content -replace '<PackageVersion>5\.9\.4</PackageVersion>', '<PackageVersion>0.0.1</PackageVersion>'
+        Set-Content $csprojPath $content -NoNewline
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: '6.x'
+
+    - name: Restore dependencies
+      run: dotnet restore apidoctools.sln
+
+    - name: Build
+      run: dotnet build apidoctools.sln -c ${{ matrix.configuration }} --no-restore
+
+    - name: Pack NuGet packages
+      run: dotnet pack mdoc/mdoc.csproj -o bin/Nuget -c ${{ matrix.configuration }} --no-build
+
+    - name: Upload build artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: build-artifacts-${{ matrix.os }}-${{ matrix.configuration }}
+        path: |
+          bin/Nuget/
+        retention-days: 7

.github/workflows/test.yml

@@ -0,0 +1,84 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main, master, dev/** ]
+  pull_request:
+    branches: [ main, master ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/master' }}
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, windows-latest] # ubuntu-latest is having issues for now
+        configuration: [Release] # mono F# generates different APIs in Debug vs Release
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: '6.x'
+
+    - name: Install Mono (required for mdoc tests) - Ubuntu
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        sudo apt install ca-certificates gnupg
+        sudo gpg --homedir /tmp --no-default-keyring --keyring gnupg-ring:/usr/share/keyrings/mono-official-archive-keyring.gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
+        sudo chmod +r /usr/share/keyrings/mono-official-archive-keyring.gpg
+        echo "deb [signed-by=/usr/share/keyrings/mono-official-archive-keyring.gpg] https://download.mono-project.com/repo/ubuntu stable-focal main" | sudo tee /etc/apt/sources.list.d/mono-official-stable.list
+        sudo apt update
+        sudo apt install mono-complete mono-vbnc
+
+    - name: Install Mono (required for mdoc tests) - macOS
+      if: matrix.os == 'macos-latest'
+      run: |
+        brew install --cask mono-mdk
+
+    - name: Restore dependencies
+      run: dotnet restore apidoctools.sln
+
+    - name: Build
+      run: dotnet build apidoctools.sln -c ${{ matrix.configuration }} --no-restore
+
+    - name: Run .NET tests
+      run: dotnet test apidoctools.sln -c ${{ matrix.configuration }} --no-build --verbosity normal --logger trx --collect "XPlat Code Coverage"
+
+    - name: Run mdoc tests
+      if: matrix.os != 'windows-latest'
+      run: make check-mdoc CONFIGURATION=${{ matrix.configuration }}
+
+    - name: Upload Test Results
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: test-results-${{ matrix.os }}-${{ matrix.configuration }}
+        path: |
+          **/TestResults/**
+        retention-days: 30
+
+    - name: Upload code coverage
+      uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: code-coverage-${{ matrix.os }}-${{ matrix.configuration }}
+        path: |
+          **/TestResults/**/coverage.*
+        retention-days: 30
+
+    - name: Report test results
+      uses: dorny/test-reporter@v2
+      if: always()
+      with:
+        name: Test Report (${{ matrix.os }})
+        path: '**/*.trx'
+        reporter: dotnet-trx

.gitignore

@@ -1,9 +1,4 @@
 .vscode
-/Test/en.*/
-/Test/html.*/
-/Test/DocTest.*
-/.v2.txt
-/.v0.txt
 packages
 NUnit.*
 TestResult.xml
@@ -17,14 +12,3 @@ obj
 *.pdb
 *.psess
 *.vspx
-mdoc/Test/actual_statistics.txt
-mdoc/Test/test-overwrite-attribute/SomeClass.xml
-mdoc/Test/test-overwrite-attribute/SomeClass.dll
-mdoc/Test/test-generic-ignored-namespace/ReadOnlySpan.dll
-mdoc/Test/test-nuget-information/input_data/
-/Debug/UwpTestWinRtComponentCpp
-Debug
-/mdoc/mdoc.Test/UwpTestWinRtComponentCpp/x64/Release
-/mdoc.Test.Cplusplus/x64/Release
-/x64/Release/UwpTestWinRtComponentCpp
-/mdoc/Properties/launchSettings.json

Directory.Build.props

@@ -3,12 +3,15 @@
     <NuGetVersionFSharpCore>4.3.4</NuGetVersionFSharpCore>
     <NuGetVersionMonoCecil>0.10.0</NuGetVersionMonoCecil>
     <NuGetVersionNUnit>3.10.1</NuGetVersionNUnit>
-    <NuGetVersionNUnit3TestAdapter>3.17.0</NuGetVersionNUnit3TestAdapter>
-    <NuGetVersionMicrosoftNETTestSdk>16.11.0</NuGetVersionMicrosoftNETTestSdk>
+    <NuGetVersionNUnitAnalyzers>3.10.0</NuGetVersionNUnitAnalyzers>
+    <NuGetVersionNUnit3TestAdapter>5.0.0</NuGetVersionNUnit3TestAdapter>
+    <NuGetVersionMicrosoftNETTestSdk>17.1.0</NuGetVersionMicrosoftNETTestSdk>
     <NuGetVersionQuickIONET>2.6.2.0</NuGetVersionQuickIONET>
     <NuGetVersionSharpZipLib>1.3.3</NuGetVersionSharpZipLib>
     <NuGetVersionSystemConfigurationConfigurationManager>6.0.0</NuGetVersionSystemConfigurationConfigurationManager>
     <NuGetVersionLuceneDotNet>3.0.3</NuGetVersionLuceneDotNet>
     <NuGetVersionNewtonsoftJson>13.0.1</NuGetVersionNewtonsoftJson>
+    <NuGetVersionSystemMemory>4.6.3</NuGetVersionSystemMemory>
+    <NuGetVersionCoverletCollector>3.1.2</NuGetVersionCoverletCollector>
   </PropertyGroup>
 </Project>

Makefile

@@ -1,36 +1,24 @@
 CONFIGURATION = Release
-BIN = bin/$(CONFIGURATION)
-MDOC = $(BIN)/mdoc.exe
 ENVIRONMENT = notwsl#use 'wsl' when running on wsl
 
 all: build
 
-build: $(MDOC)
+clean:
+	dotnet clean apidoctools.sln -c $(CONFIGURATION)
 
-$(MDOC):
-	dotnet build -v:n apidoctools.sln /p:Configuration=$(CONFIGURATION)
+build:
+	dotnet build apidoctools.sln -c $(CONFIGURATION)
 
-prepare:
-	git submodule update --init --recursive
-	dotnet restore apidoctools.sln
-	nuget install NUnit.Console -version 3.6.0 -NoCache -o packages
+nuget:
+	dotnet pack mdoc/mdoc.csproj -o bin/Nuget
 
-clean:
-	dotnet build -v:n apidoctools.sln /t:clean /p:Configuration=$(CONFIGURATION)
-	rm -rf bin/$(CONFIGURATION)
+check: build test check-monodoc check-mdoc
 
-check: build check-monodoc check-mdoc
+test:
+	dotnet test apidoctools.sln -c $(CONFIGURATION)
 
 check-mdoc:
-	cd mdoc; $(MAKE) check -B
-
-nuget:
-	nuget pack mdoc/mdoc.nuspec -outputdirectory bin/Nuget
+	cd tests/mdoc; $(MAKE) check -B
 
 check-monodoc:
-	cd monodoc; $(MAKE) check -B
-
-zip:
-	rm -f $(BIN)/mdoc*.zip
-	zip -j $(BIN)/mdoc.zip $(BIN)/*
-
+	dotnet test -c $(CONFIGURATION)

Mdoc-ReleaseCheckCI.yml

@@ -42,7 +42,7 @@ jobs:
     displayName: Compare xml files
     timeoutInMinutes: 600
     inputs:
-      filePath: mdoc/compareXmlFiles.ps1
+      filePath: tools/compareXmlFiles.ps1
       arguments: -paramsJson '$(params)' -githubTokenBase64 '$(githubTokenBase64)' -githubOptionsAccountName $(githubOptionsAccountName) -githubOptionsAccountEmail $(githubOptionsAccountEmail) -vstsTokenBase64 '$(vstsTokenBase64)' -step '1' -commit1 ''
     enabled: true
     name: job1output
@@ -93,7 +93,7 @@ jobs:
     displayName: Compare xml files
     timeoutInMinutes: 600
     inputs:
-      filePath: mdoc/compareXmlFiles.ps1
+      filePath: tools/compareXmlFiles.ps1
       arguments: -paramsJson '$(params)' -githubTokenBase64 '$(githubTokenBase64)' -githubOptionsAccountName $(githubOptionsAccountName) -githubOptionsAccountEmail $(githubOptionsAccountEmail) -vstsTokenBase64 '$(vstsTokenBase64)' -step '2' -commit1 '$(commit1)'
     enabled: true
     name: job2output

README.md

@@ -84,4 +84,4 @@ make prepare all check
 Please review [mono's installation guide](http://www.mono-project.com/download/#download-lin) if you are using a different flavor of linux.
 
 ## How to debug
-[How to debug mdoc](./Documentation/how-to-debug/how-to-debug-mdoc.md)
+[How to debug mdoc](./docs/how-to-debug/how-to-debug-mdoc.md)