Saltar al contenido

Plantilla de flujo de trabajo de GitHub Actions para .NET

Última actualización

Este es un .github/workflows/ci.yml funcional para una solución .NET. Instala el SDK, guarda en caché la carpeta de paquetes de NuGet, hace restore una sola vez, compila en modo Release y ejecuta las pruebas sin volver a compilar.

El flujo de trabajo

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

Qué hacen las partes menos evidentes

  • dotnet-version: 9.0.x usa el último parche de la 9.0. Utilice la versión mayor que tome su proyecto como objetivo, o global-json-file: global.json para seguir el SDK fijado en su repositorio.
  • El paso de caché de NuGet guarda ~/.nuget/packages. setup-dotnet tiene una opción cache: true, pero requiere un archivo de bloqueo packages.lock.json, por lo que un paso explícito con actions/cache es más universal. Use como clave los archivos del proyecto, de modo que añadir un paquete genere una nueva caché.
  • restore, después --no-restore, después --no-build. Cada paso hace una sola tarea. Sin estas opciones, build y test repetirían los pasos anteriores y desperdiciarían tiempo.
  • Variables de entorno. Las tres configuraciones DOTNET_ eliminan el banner de bienvenida, la telemetría y las tareas de primera ejecución que saturan los registros.
  • Configuración Release. Las pruebas se ejecutan sobre lo que se distribuye. Use Debug solo si las pruebas dependen de los símbolos de depuración.
  • Runner de Linux. .NET es multiplataforma, y los minutos de Linux son los más económicos.

Variantes

Contenedor de servicio SQL Server

    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

Después, configure la cadena de conexión mediante una variable de entorno. La imagen de SQL Server necesita más memoria y tiempo para arrancar que Postgres. Un servicio Postgres, como en la plantilla de Django, usa la misma estructura.

Múltiples frameworks de destino

Añada una matriz con dotnet-version: [8.0.x, 9.0.x]. Consulte compilaciones con matriz.

Cobertura de código

Añada --collect:"XPlat Code Coverage" a dotnet test y suba los resultados como un artefacto.

Publicar y desplegar

Añada un segundo job con needs: build en main que ejecute dotnet publish -c Release -o out, y despliegue usando OIDC.

Windows o macOS

Añádalos a una matriz para bibliotecas de escritorio o multiplataforma. Windows cuesta más por minuto, así que úselo solo cuando sea necesario.

Ejecútelo en máquinas más rápidas

Cambie una línea:

    runs-on: [self-hosted, Linux, compiler-ci]

El job se ejecuta en una máquina nueva de 8 vCPU de compiler.dev, con retroceso automático a su runner original. El benchmark de compiler.dev de React con ASP.NET Core y SQL Server pasó de 3m34s a 1m41s; consulte benchmarks. Más información en acelerar .NET en GitHub Actions, y precios en precios.

Preguntas frecuentes

¿Por qué no usar la opción de caché de setup-dotnet?

Solo funciona si usa archivos de bloqueo de NuGet. Si los usa, cache: true es más sencillo.

¿Necesito hacer restore por separado?

No estrictamente, pero un restore separado hace visible el efecto de la caché en los registros y le permite usar --no-restore después.

¿Cómo ejecuto las pruebas en paralelo?

xUnit y NUnit paralelizan dentro de un proyecto. Para más, use sharding de pruebas por proyecto.

¿Qué pasa con las reglas de contraseña de SQL Server?

La contraseña de sa debe cumplir las reglas de complejidad o el contenedor se cierra. La contraseña del ejemplo las cumple.