Skip to content

docs: update README #1405

docs: update README

docs: update README #1405

Workflow file for this run

name: "CI"
on:
workflow_dispatch:
pull_request:
branches: [main]
jobs:
test-macos:
name: Test (MacOS)
runs-on: macos-latest
steps:
- name: Checkout sources
uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4
with:
fetch-depth: 0
- name: Setup .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: |
6.0.x
7.0.x
- name: Build solution
run: dotnet build /p:NetCoreOnly=True --configuration "Release"
- name: Run tests
uses: Wandalen/wretry.action@v1.3.0
with:
command: dotnet test --no-build --collect:"XPlat Code Coverage" --logger trx --results-directory "TestResults"
attempt_limit: 2
- name: Upload test results (MacOS)
if: ${{ always() }}
uses: actions/upload-artifact@v3
with:
name: Test results (MacOS)
path: TestResults
- name: Upload coverage
uses: actions/upload-artifact@v3
with:
name: Code coverage (MacOS)
path: "**/coverage.cobertura.xml"
test-ubuntu:
name: Test (Ubuntu)
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4
with:
fetch-depth: 0
- name: Setup .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: |
6.0.x
7.0.x
- name: Build solution
run: dotnet build /p:NetCoreOnly=True --configuration "Release"
- name: Run tests
uses: Wandalen/wretry.action@v1.3.0
with:
command: dotnet test --no-build --collect:"XPlat Code Coverage" --logger trx --results-directory "TestResults"
attempt_limit: 2
- name: Upload test results (Ubuntu)
if: ${{ always() }}
uses: actions/upload-artifact@v3
with:
name: Test results (Ubuntu)
path: TestResults
- name: Upload coverage
uses: actions/upload-artifact@v3
with:
name: Code coverage (Ubuntu)
path: "**/coverage.cobertura.xml"
test-windows:
name: Test (Windows)
runs-on: windows-latest
steps:
- name: Checkout sources
uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4
with:
fetch-depth: 0
- name: Setup .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: |
6.0.x
7.0.x
- name: Build solution
run: dotnet build /p:NetCoreOnly=True --configuration "Release"
- name: Run tests
uses: Wandalen/wretry.action@v1.3.0
with:
command: dotnet test --no-build --collect:"XPlat Code Coverage" --logger trx --results-directory "TestResults"
attempt_limit: 2
- name: Upload test results (Windows)
if: ${{ always() }}
uses: actions/upload-artifact@v3
with:
name: Test results (Windows)
path: TestResults
- name: Upload coverage
uses: actions/upload-artifact@v3
with:
name: Code coverage (Windows)
path: "**/coverage.cobertura.xml"
test-net-framework:
name: Test (.NET Framework)
runs-on: windows-latest
steps:
- name: Checkout sources
uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4
with:
fetch-depth: 0
- name: Setup MSBuild
uses: microsoft/setup-msbuild@v1
- name: Setup VSTest
uses: darenm/Setup-VSTest@v1
- name: Navigate to Workspace
run: cd $GITHUB_WORKSPACE
- name: Build solution
run: msbuild.exe Testably.Abstractions.sln /p:NetFrameworkOnly=True /p:platform="Any CPU" /p:configuration="Release" -t:restore,build -p:RestorePackagesConfig=true
- name: Run tests
run: vstest.console.exe .\Build\Tests\Testably.Abstractions.Tests\net48\Testably.Abstractions.Tests.dll .\Build\Tests\Testably.Abstractions.Parity.Tests\net48\Testably.Abstractions.Parity.Tests.dll .\Build\Tests\Testably.Abstractions.Testing.Tests\net48\Testably.Abstractions.Testing.Tests.dll /Logger:trx /ResultsDirectory:TestResults
- name: Upload test results (.NET Framework)
if: ${{ always() }}
uses: actions/upload-artifact@v3
with:
name: Test results (.NET Framework)
path: TestResults
test-examples:
name: Test (Examples)
runs-on: windows-latest
steps:
- name: Checkout sources
uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4
with:
fetch-depth: 0
- name: Save PR number to file
if: github.event_name == 'pull_request'
run: echo ${{ github.event.number }} > PR_NUMBER.txt
- name: Archive PR number
if: github.event_name == 'pull_request'
uses: actions/upload-artifact@v3
with:
name: PR_NUMBER
path: PR_NUMBER.txt
- name: Setup .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: |
6.0.x
7.0.x
- name: Build solution
run: dotnet build /p:NetCoreOnly=True --configuration "Release"
- name: Build example solution
run: dotnet build Examples /p:UseFileReferenceToTestablyLibraries=True
- name: Run example tests
uses: Wandalen/wretry.action@v1.3.0
with:
command: dotnet test Examples --no-build
attempt_limit: 2