chore: add Markdown API doc generation tooling #44
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Action pinning policy: | |
| # - First-party `actions/*` actions are pinned to a major version tag (e.g. @v4). | |
| # - Any third-party action must be pinned to a full commit SHA with a | |
| # version comment. (None are currently used.) | |
| name: test | |
| on: | |
| push: | |
| branches: [main] | |
| paths-ignore: | |
| - "**.md" | |
| - "docs/**" | |
| - "LICENSE" | |
| - ".gitignore" | |
| - ".editorconfig" | |
| pull_request: | |
| branches: [main] | |
| paths-ignore: | |
| - "**.md" | |
| - "docs/**" | |
| - "LICENSE" | |
| - ".gitignore" | |
| - ".editorconfig" | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: ${{ github.event_name == 'pull_request' }} | |
| permissions: | |
| contents: read | |
| jobs: | |
| test: | |
| name: test (${{ matrix.tfm }}) | |
| runs-on: [self-hosted, linux, arm64, arcp] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| tfm: [net10.0] | |
| env: | |
| # setup-dotnet defaults to /usr/share/dotnet, not writable by the | |
| # self-hosted runner user. | |
| DOTNET_INSTALL_DIR: /home/app/.dotnet | |
| DOTNET_NOLOGO: "true" | |
| DOTNET_CLI_TELEMETRY_OPTOUT: "true" | |
| DOTNET_SKIP_FIRST_TIME_EXPERIENCE: "true" | |
| NUGET_XMLDOC_MODE: skip | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 1 | |
| - name: Setup .NET (from global.json) | |
| uses: actions/setup-dotnet@v5 | |
| with: | |
| global-json-file: global.json | |
| - name: Cache NuGet packages | |
| uses: actions/cache@v5 | |
| with: | |
| path: ~/.nuget/packages | |
| key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj', '**/Directory.Packages.props', '**/global.json', '**/nuget.config') }} | |
| restore-keys: | | |
| ${{ runner.os }}-nuget- | |
| - name: Restore | |
| run: dotnet restore ARCP.slnx | |
| - name: Format check | |
| run: dotnet format ARCP.slnx --verify-no-changes --no-restore | |
| - name: Build | |
| run: dotnet build ARCP.slnx --configuration Release --no-restore | |
| - name: Test (all test projects, with coverage) | |
| run: > | |
| dotnet test ARCP.slnx | |
| --configuration Release | |
| --no-build | |
| --verbosity normal | |
| --collect:"XPlat Code Coverage" | |
| --logger "trx;LogFileName=tests.trx" | |
| --logger "console;verbosity=detailed" | |
| --results-directory ${{ github.workspace }}/TestResults | |
| - name: Coverage gate (line coverage >= 80%) | |
| run: | | |
| python3 scripts/check-coverage.py --threshold 80 --results-dir "${{ github.workspace }}/TestResults" | |
| # `--collect:"XPlat Code Coverage"` (coverlet.collector) writes one | |
| # coverage.cobertura.xml per test project under TestResults/<guid>/. | |
| # Non-blocking: a Codecov outage must not break CI. | |
| - name: Upload coverage to Codecov | |
| # codecov/codecov-action v6.0.1 | |
| uses: codecov/codecov-action@e79a6962e0d4c0c17b229090214935d2e33f8354 # v6.0.1 | |
| with: | |
| fail_ci_if_error: false | |
| flags: unittests | |
| directory: ${{ github.workspace }}/TestResults | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| - name: Upload test results | |
| if: failure() | |
| uses: actions/upload-artifact@v7 | |
| with: | |
| name: test-results-${{ matrix.tfm }} | |
| path: ${{ github.workspace }}/TestResults | |
| if-no-files-found: ignore | |
| retention-days: 7 |