Add docblocks #71
This file contains 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
| name: Report | |
| on: | |
| pull_request: | |
| paths-ignore: | |
| - "StepLang.Wiki/**" | |
| - "StepLang.Homepage/**" | |
| branches: [ "main" ] | |
| env: | |
| DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true | |
| DOTNET_CLI_TELEMETRY_OPTOUT: true | |
| jobs: | |
| coverage: | |
| name: Get Test Coverage | |
| runs-on: ubuntu-latest | |
| outputs: | |
| badge: ${{ steps.coverage.outputs.badge || steps.coverage-failure.outputs.badge }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup .NET | |
| uses: actions/setup-dotnet@v3 | |
| with: | |
| dotnet-version: 8.x | |
| - name: Cache NuGet packages | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.nuget/packages | |
| key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }} | |
| restore-keys: | | |
| ${{ runner.os }}-nuget- | |
| - name: Restore dependencies | |
| run: dotnet restore | |
| - name: Build | |
| run: dotnet build --configuration Test --no-restore | |
| - name: Test | |
| run: dotnet test --configuration Test --no-build --verbosity normal --collect:"XPlat Code Coverage" --results-directory ./coverage | |
| - name: Provide Code Coverage Summary | |
| id: coverage | |
| uses: ricardoboss/CodeCoverageSummary@dev | |
| with: | |
| filename: coverage/**/coverage.cobertura.xml | |
| output: github | |
| fail_below_min: true | |
| thresholds: '0 85' | |
| badge: true | |
| - name: Provide failure badge | |
| id: coverage-failure | |
| if: failure() | |
| run: | | |
| echo "badge=https://img.shields.io/badge/Test%20Coverage-failed-red.svg?style=flat" >> "$GITHUB_OUTPUT" | |
| style: | |
| name: Check Style | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup .NET | |
| uses: actions/setup-dotnet@v3 | |
| with: | |
| dotnet-version: 8.x | |
| - name: Check Style | |
| id: style | |
| run: dotnet tool update dotnet-format -g && dotnet format --verify-no-changes | |
| docblocks: | |
| name: Check Docblocks | |
| runs-on: ubuntu-latest | |
| outputs: | |
| total: ${{ steps.docblocks.outputs.total }} | |
| documented: ${{ steps.docblocks.outputs.documented }} | |
| badge: ${{ steps.docblocks.outputs.badge }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup .NET | |
| uses: actions/setup-dotnet@v3 | |
| with: | |
| dotnet-version: 8.x | |
| - name: Check Docblock Coverage | |
| id: docblocks | |
| run: dotnet tool update cranky -g && cranky --project ./StepLang/StepLang.csproj --github --set-exit-code --percentages 0,50 | |
| report: | |
| name: Report | |
| if: always() | |
| needs: [ coverage, style, docblocks ] | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pull-requests: write | |
| steps: | |
| - name: Add PR comment | |
| uses: thollander/actions-comment-pull-request@v2 | |
| with: | |
| comment_tag: report | |
| message: | | |
|    |