.NET GitHub Actions Workflow-Vorlage
Zuletzt aktualisiert am
Dies ist eine funktionierende .github/workflows/ci.yml für eine .NET-Solution. Sie installiert das SDK, cacht den NuGet-Paketordner, führt den Restore einmal aus, baut im Release-Modus und führt die Tests aus, ohne erneut zu bauen.
Der Workflow
name: CI
on:
push:
branches: [main]
pull_request:
permissions:
contents: read
concurrency:
group: ci-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
env:
DOTNET_NOLOGO: "true"
DOTNET_CLI_TELEMETRY_OPTOUT: "true"
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: "true"
jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- uses: actions/checkout@v4
- uses: actions/setup-dotnet@v4
with:
dotnet-version: 9.0.x
- uses: actions/cache@v4
with:
path: ~/.nuget/packages
key: nuget-${{ runner.os }}-${{ hashFiles('**/*.csproj', '**/Directory.Packages.props', '**/packages.lock.json') }}
restore-keys: |
nuget-${{ runner.os }}-
- run: dotnet restore
- run: dotnet build --no-restore --configuration Release
- run: dotnet test --no-build --configuration Release --verbosity normal
Was die nicht offensichtlichen Teile bewirken
dotnet-version: 9.0.xverwendet den neuesten 9.0-Patch. Wählen Sie die Hauptversion, auf die Ihr Projekt zielt, oder nutzen Sieglobal-json-file: global.json, um dem in Ihrem Repo fixierten SDK zu folgen.- Der NuGet-Cache-Schritt speichert
~/.nuget/packages.setup-dotnetbietet die Optioncache: true, benötigt dafür aber einepackages.lock.json-Lock-Datei. Ein expliziteractions/cache-Schritt ist deshalb breiter einsetzbar. Er wird über die Projektdateien geschlüsselt, sodass das Hinzufügen eines Pakets einen neuen Cache erzeugt. restore, dann--no-restore, dann--no-build. Jeder Schritt erledigt genau eine Aufgabe. Ohne diese Flags würdenbuildundtestdie vorherigen Schritte jeweils erneut ausführen und so Zeit verschwenden.- Umgebungsvariablen. Die drei
DOTNET_-Einstellungen entfernen das Willkommensbanner, die Telemetrie und die Arbeiten beim ersten Start, die die Logs unübersichtlich machen. - Release-Konfiguration. Tests laufen gegen das, was Sie ausliefern. Verwenden Sie Debug nur, wenn Tests auf Debug-Symbole angewiesen sind.
- Linux-Runner. .NET läuft plattformübergreifend, und Linux-Minuten sind am günstigsten.
Varianten
SQL-Server-Service-Container
services:
mssql:
image: mcr.microsoft.com/mssql/server:2022-latest
env:
ACCEPT_EULA: "Y"
MSSQL_SA_PASSWORD: "Ci_Passw0rd!"
ports:
- 1433:1433
options: >-
--health-cmd "/opt/mssql-tools18/bin/sqlcmd -C -S localhost -U sa -P Ci_Passw0rd! -Q 'SELECT 1'"
--health-interval 10s
--health-retries 10
Setzen Sie anschließend den Verbindungsstring über eine Umgebungsvariable. Das SQL-Server-Image benötigt mehr Arbeitsspeicher und Zeit zum Starten als Postgres. Ein Postgres-Service, wie in der Django-Vorlage, folgt derselben Struktur.
Mehrere Ziel-Frameworks
Fügen Sie eine Matrix mit dotnet-version: [8.0.x, 9.0.x] hinzu. Siehe Matrix-Builds.
Code-Coverage
Fügen Sie --collect:"XPlat Code Coverage" zu dotnet test hinzu und laden Sie die Ergebnisse als Artefakt hoch.
Veröffentlichen und Deployment
Fügen Sie einen zweiten Job mit needs: build auf main hinzu, der dotnet publish -c Release -o out ausführt, und deployen Sie per OIDC.
Windows oder macOS
Nehmen Sie diese in eine Matrix für Desktop- oder plattformübergreifende Bibliotheken auf. Windows kostet pro Minute mehr, verwenden Sie es also nur dort, wo es nötig ist.
Auf schnelleren Maschinen ausführen
Ändern Sie eine Zeile:
runs-on: [self-hosted, Linux, compiler-ci]
Der Job läuft auf einer frischen 8-vCPU-Maschine von compiler.dev, mit automatischem Fallback auf Ihren ursprünglichen Runner. Der Benchmark von compiler.dev mit React, ASP.NET Core und SQL Server verkürzte die Laufzeit von 3m34s auf 1m41s; siehe Benchmarks. Mehr dazu unter .NET auf GitHub Actions beschleunigen, die Preise finden Sie unter Preise.
FAQ
Warum nicht die Cache-Option von setup-dotnet verwenden?
Sie funktioniert nur, wenn Sie NuGet-Lock-Dateien verwenden. Falls ja, ist cache: true einfacher.
Muss ich den Restore separat ausführen?
Nicht zwingend, aber ein separater Restore macht den Cache-Effekt in den Logs sichtbar und ermöglicht danach die Verwendung von --no-restore.
Wie führe ich Tests parallel aus?
xUnit und NUnit parallelisieren innerhalb eines Projekts. Für mehr verwenden Sie Test-Sharding nach Projekt.
Welche Regeln gelten für das SQL-Server-Passwort?
Das sa-Passwort muss die Komplexitätsregeln erfüllen, sonst beendet sich der Container. Das Beispielpasswort erfüllt sie.
Verwandt
- .NET in GitHub Actions beschleunigen.NET-Builds in GitHub Actions beschleunigen: NuGet-Caching mit setup-dotnet, --no-restore, --no-build, paralleles dotnet test und SQL-Server-Services.
- Django GitHub Actions Workflow-VorlageFertige GitHub-Actions-CI für Django mit Postgres-Service-Container, pip-Caching, Migrationsprüfung und Tests sowie Concurrency und Berechtigungen.
- Docker Build GitHub Actions Workflow VorlageFertiger GitHub-Actions-Workflow zum Bauen von Docker-Images mit Buildx, GitHub-Cache-Layern und einem Push zu GHCR auf main, mit minimalen Berechtigungen.
- Elixir GitHub Actions Workflow-VorlageFertige GitHub-Actions-CI für Elixir und Phoenix mit Postgres-Service, Caching von deps und _build über erlef/setup-beam sowie Formatierung und Tests.