docs: add API reference publishing with DocFX #78
Workflow file for this run
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
| name: PR Check | |
| on: | |
| pull_request: | |
| permissions: | |
| contents: read | |
| jobs: | |
| build: | |
| name: build (${{ matrix.configuration }}) | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| configuration: [ Debug, Release ] | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: actions/setup-dotnet@v5 | |
| with: | |
| dotnet-version: 10.0.x | |
| - name: Restore | |
| run: dotnet restore ModularityKit.Mutator.slnx | |
| - name: Build ${{ matrix.configuration }} | |
| run: dotnet build ModularityKit.Mutator.slnx -c ${{ matrix.configuration }} --no-restore | |
| dependency-health: | |
| name: dependency health | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: actions/setup-dotnet@v5 | |
| with: | |
| dotnet-version: 10.0.x | |
| - name: Restore | |
| run: dotnet restore ModularityKit.Mutator.slnx | |
| - name: Check dependency health | |
| run: python3 -m scripts.dependencies.check_package_health --solution ModularityKit.Mutator.slnx | |
| docs: | |
| name: docs | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: actions/setup-dotnet@v5 | |
| with: | |
| dotnet-version: 10.0.x | |
| - name: Install DocFX | |
| run: dotnet tool update -g docfx | |
| - name: Build docs | |
| run: docfx docfx.json | |
| tests: | |
| name: ${{ matrix.name }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - name: test:core | |
| command: dotnet test Tests/ModularityKit.Mutator.Tests/ModularityKit.Mutator.Tests.csproj -c Release --no-restore | |
| - name: test:governance | |
| command: dotnet test Tests/ModularityKit.Mutator.Governance.Tests/ModularityKit.Mutator.Governance.Tests.csproj -c Release --no-restore | |
| - name: test:governance-redis | |
| command: dotnet test Tests/ModularityKit.Mutator.Governance.Redis.Tests/ModularityKit.Mutator.Governance.Redis.Tests.csproj -c Release --no-restore | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: actions/setup-dotnet@v5 | |
| with: | |
| dotnet-version: 10.0.x | |
| - name: Restore | |
| run: dotnet restore ModularityKit.Mutator.slnx | |
| - name: Run ${{ matrix.name }} | |
| run: ${{ matrix.command }} | |
| examples-core: | |
| name: ${{ matrix.name }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - name: examples:core / BillingQuotas | |
| command: dotnet run --project Examples/Core/BillingQuotas/BillingQuotas.csproj -c Release --no-restore | |
| - name: examples:core / FeatureFlags | |
| command: dotnet run --project Examples/Core/FeatureFlags/FeatureFlags.csproj -c Release --no-restore | |
| - name: examples:core / IamRoles | |
| command: dotnet run --project Examples/Core/IamRoles/IamRoles.csproj -c Release --no-restore | |
| - name: examples:core / WorkflowApprovals | |
| command: dotnet run --project Examples/Core/WorkflowApprovals/WorkflowApprovals.csproj -c Release --no-restore | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: actions/setup-dotnet@v5 | |
| with: | |
| dotnet-version: 10.0.x | |
| - name: Restore | |
| run: dotnet restore ModularityKit.Mutator.slnx | |
| - name: Run ${{ matrix.name }} | |
| run: ${{ matrix.command }} | |
| examples-governance: | |
| name: ${{ matrix.name }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - name: examples:governance / RequestLifecycle | |
| command: dotnet run --project Examples/Governance/RequestLifecycle/RequestLifecycle.csproj -c Release --no-restore | |
| - name: examples:governance / GovernedExecution | |
| command: dotnet run --project Examples/Governance/GovernedExecution/GovernedExecution.csproj -c Release --no-restore | |
| - name: examples:governance / DecisionTaxonomy | |
| command: dotnet run --project Examples/Governance/DecisionTaxonomy/DecisionTaxonomy.csproj -c Release --no-restore | |
| - name: examples:governance / ApprovalWorkflow | |
| command: dotnet run --project Examples/Governance/ApprovalWorkflow/ApprovalWorkflow.csproj -c Release --no-restore | |
| - name: examples:governance / VersionedResolution | |
| command: dotnet run --project Examples/Governance/VersionedResolution/VersionedResolution.csproj -c Release --no-restore | |
| - name: examples:governance / Queries | |
| command: dotnet run --project Examples/Governance/Queries/Queries.csproj -c Release --no-restore | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: actions/setup-dotnet@v5 | |
| with: | |
| dotnet-version: 10.0.x | |
| - name: Restore | |
| run: dotnet restore ModularityKit.Mutator.slnx | |
| - name: Run ${{ matrix.name }} | |
| run: ${{ matrix.command }} | |
| examples-governance-redis: | |
| name: examples:governance / RedisQueries | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: actions/setup-dotnet@v5 | |
| with: | |
| dotnet-version: 10.0.x | |
| - name: Restore | |
| run: dotnet restore ModularityKit.Mutator.slnx | |
| - name: Start Redis | |
| working-directory: Examples/Governance/RedisQueries | |
| run: docker compose up -d | |
| - name: Run RedisQueries | |
| env: | |
| MODULARITYKIT_REDIS: localhost:6379 | |
| run: dotnet run --project Examples/Governance/RedisQueries/RedisQueries.csproj -c Release --no-restore | |
| - name: Stop Redis | |
| if: ${{ always() }} | |
| working-directory: Examples/Governance/RedisQueries | |
| run: docker compose down | |
| validation-summary: | |
| name: validation summary | |
| runs-on: ubuntu-latest | |
| needs: | |
| - build | |
| - dependency-health | |
| - docs | |
| - tests | |
| - examples-core | |
| - examples-governance | |
| - examples-governance-redis | |
| if: always() | |
| steps: | |
| - name: Report job results | |
| run: | | |
| echo "build: ${{ needs.build.result }}" | |
| echo "dependency-health: ${{ needs.dependency-health.result }}" | |
| echo "docs: ${{ needs.docs.result }}" | |
| echo "tests: ${{ needs.tests.result }}" | |
| echo "examples-core: ${{ needs.examples-core.result }}" | |
| echo "examples-governance: ${{ needs.examples-governance.result }}" | |
| echo "examples-governance-redis: ${{ needs.examples-governance-redis.result }}" | |
| if [ "${{ needs.build.result }}" != "success" ] || \ | |
| [ "${{ needs.dependency-health.result }}" != "success" ] || \ | |
| [ "${{ needs.docs.result }}" != "success" ] || \ | |
| [ "${{ needs.tests.result }}" != "success" ] || \ | |
| [ "${{ needs.examples-core.result }}" != "success" ] || \ | |
| [ "${{ needs.examples-governance.result }}" != "success" ] || \ | |
| [ "${{ needs.examples-governance-redis.result }}" != "success" ]; then | |
| exit 1 | |
| fi |