Skip to content
ci

docs: clearer examples in routing.md #134

Sign in to view logs

docs: clearer examples in routing.md

docs: clearer examples in routing.md #134

Workflow file for this run

.github/workflows/ci.yml at 314b860
# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
name: ci
on:
workflow_dispatch: # Allow running the workflow manually from the GitHub UI
push:
branches:
- 'main' # Run the workflow when pushing to the main branch
pull_request:
branches:
- '*' # Run the workflow for all pull requests
release:
types:
- published # Run the workflow when a new GitHub release is published
concurrency:
group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/main' && github.run_id || github.event.pull_request.number || github.ref }}
cancel-in-progress: true
env:
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
DOTNET_NOLOGO: true
NuGetDirectory: ${{ github.workspace}}/nuget
TestResultsDirectory: ${{ github.workspace}}/TestResults
BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
jobs:
create-nuget:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # Get all history to allow automatic versioning using MinVer
# Install the .NET SDK indicated in the global.json file
- name: Setup .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: 8.0.x
# Create the NuGet package in the folder from the environment variable NuGetDirectory
- run: dotnet pack ./src/* --configuration Release --output ${{ env.NuGetDirectory }}
# Publish the NuGet package as an artifact, so they can be used in the following jobs
- uses: actions/upload-artifact@v4
with:
name: nuget
if-no-files-found: error
retention-days: 7
path: ${{ env.NuGetDirectory }}/*.nupkg
validate-nuget:
runs-on: ubuntu-latest
needs: [ create-nuget ]
steps:
- name: Setup .NET
uses: actions/setup-dotnet@v4
- uses: actions/download-artifact@v4
with:
name: nuget
path: ${{ env.NuGetDirectory }}
- name: Install nuget validator
run: dotnet tool update Meziantou.Framework.NuGetPackageValidation.Tool --global
# Validate metadata and content of the NuGet package
# https://www.nuget.org/packages/Meziantou.Framework.NuGetPackageValidation.Tool#readme-body-tab
# If some rules are not applicable, you can disable them
# using the --excluded-rules or --excluded-rule-ids option
- name: Validate package
shell: pwsh
run: meziantou.validate-nuget-package (Get-ChildItem "${{ env.NuGetDirectory }}/*.nupkg") --excluded-rules IconMustBeSet
run-test:
runs-on: ubuntu-latest
timeout-minutes: 30
env:
TestResultsDirectory: ${{ github.workspace }}/TestResults
permissions:
contents: read
checks: write
statuses: write
steps:
- uses: actions/checkout@v4
- name: Setup .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: 8.0.x
- name: Build solution
run: dotnet build -c Release
- name: Ensure browsers are installed
run: pwsh /home/runner/work/Htmxor/Htmxor/test/Htmxor.Tests/bin/Release/net8.0/playwright.ps1 install --with-deps
- name: Run tests
run: dotnet test --configuration Release --logger trx --results-directory "${{ env.TestResultsDirectory }}" --collect:"XPlat Code Coverage" --blame-hang --blame-hang-timeout 5min
- uses: actions/upload-artifact@v4
if: always()
with:
name: test-results
if-no-files-found: error
retention-days: 3
path: ${{ env.TestResultsDirectory }}/**/*
- name: Test Report
uses: dorny/test-reporter@v1
if: always() && ((github.event_name == 'push' && github.ref == 'refs/heads/main') || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'egil/Htmxor'))
with:
name: test-results
path: ${{ env.TestResultsDirectory }}/**/*.trx
path-replace-backslashes: 'true'
reporter: dotnet-trx
run-stryker:
runs-on: ubuntu-latest
if: github.event_name != 'release'
env:
StrykerDirectory: ${{ github.workspace }}/Stryker
permissions:
contents: read
checks: write
statuses: write
steps:
- uses: actions/checkout@v4
- name: Setup .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: 8.0.x
- name: Build solution
run: dotnet build -c Release
- name: Ensure browsers are installed
run: pwsh /home/runner/work/Htmxor/Htmxor/test/Htmxor.Tests/bin/Release/net8.0/playwright.ps1 install --with-deps
- name: Install Stryker.NET
run: dotnet tool install -g dotnet-stryker
- name: Run Stryker.NET
id: strykerLocal
if: (github.event_name == 'push' && github.ref == 'refs/heads/main') || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'egil/Htmxor')
run: |
cd test/Htmxor.Tests
dotnet stryker --config-file "../../stryker-config.json" --dashboard-api-key "${{ secrets.STRYKER_DASHBOARD_API_KEY }}" --version ${{ env.BRANCH_NAME }} --output ${{ env.StrykerDirectory }}
cat ${{ env.StrykerDirectory }}/reports/mutation-report.md >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "View the [full report](https://dashboard.stryker-mutator.io/reports/github.com/egil/Htmxor/${{ env.BRANCH_NAME }})." >> $GITHUB_STEP_SUMMARY
- name: Run Stryker.NET
id: strykerFork
if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != 'egil/Htmxor'
run: |
cd test/Htmxor.Tests
dotnet stryker --config-file "../../stryker-config-no-dashboard.json" --version ${{ env.BRANCH_NAME }} --output ${{ env.StrykerDirectory }}
cat ${{ env.StrykerDirectory }}/reports/mutation-report.md >> $GITHUB_STEP_SUMMARY
- name: Stryker Report
if: steps.strykerLocal.outcome == 'success'
uses: Sibz/github-status-action@v1
with:
authToken: ${{secrets.GITHUB_TOKEN}}
context: stryker-report"
description: "See report"
state: ${{ steps.strykerLocal.conclusion }}
sha: ${{ github.event.pull_request.head.sha || github.sha }}
target_url: https://dashboard.stryker-mutator.io/reports/github.com/egil/Htmxor/${{ env.BRANCH_NAME }}
- uses: actions/upload-artifact@v4
with:
name: stryker-reports
if-no-files-found: error
retention-days: 3
path: ${{ env.StrykerDirectory }}/**/*
dependency-review:
runs-on: ubuntu-latest
permissions:
contents: read
if: github.event_name == 'pull_request' && github.repository == 'egil/Htmxor'
steps:
- name: 'Checkout Repository'
uses: actions/checkout@v4
- name: 'Dependency Review'
uses: actions/dependency-review-action@v4
infer-sharp:
runs-on: ubuntu-latest
if: github.event_name != 'release'
permissions:
security-events: write
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: 8.0.x
- run: dotnet build --configuration Release
- name: Run Infer#
uses: microsoft/[email protected]
id: runinfersharp
with:
binary-path: ./src/Htmxor/bin/Release/net8.0
github-sarif: true
- name: Create step summary
run: |
echo # Infer# report >> $GITHUB_STEP_SUMMARY
echo ``` >> $GITHUB_STEP_SUMMARY
cat infer-out/report.txt >> $GITHUB_STEP_SUMMARY
echo ``` >> $GITHUB_STEP_SUMMARY
- name: Upload Infer# report as an artifact
uses: actions/upload-artifact@v4
with:
name: infer-sharp-report
path: infer-out/report.txt
- name: Upload SARIF output to GitHub Security Center
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: github/codeql-action/upload-sarif@v3
with:
sarif_file: infer-out/report.sarif
deploy:
# Publish only when creating a GitHub Release
# https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository
# You can update this logic if you want to manage releases differently
if: github.event_name == 'release' || github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
needs: [ validate-nuget, run-test ]
steps:
- uses: actions/download-artifact@v4
with:
name: nuget
path: ${{ env.NuGetDirectory }}
- name: Setup .NET Core
uses: actions/setup-dotnet@v4
- name: Publish NuGet package
shell: pwsh
run: |
foreach($file in (Get-ChildItem "${{ env.NuGetDirectory }}" -Recurse -Include *.nupkg)) {
dotnet nuget push $file --api-key "${{ secrets.NUGET_APIKEY }}" --source https://api.nuget.org/v3/index.json --skip-duplicate
}