Rychlý start: Vytvoření pracovního postupu GitHubu pro ověření testu

Článek
03/05/2024

V tomto rychlém startu se dozvíte, jak vytvořit pracovní postup GitHubu pro otestování zdrojového kódu .NET. Automatické testování kódu .NET na GitHubu se označuje jako kontinuální integrace (CI), kde se žádosti o přijetí změn nebo změny ve zdrojových aktivačních pracovních postupech pro cvičení označují. Spolu s sestavením zdrojového kódu testování zajistíte, že zkompilovaný zdrojový kód funguje jako autor. Testy jednotek častěji slouží jako okamžitá smyčka zpětné vazby, která pomáhá zajistit platnost změn ve zdrojovém kódu.

Požadavky

Účet GitHub.
Úložiště zdrojového kódu .NET.

Vytvoření souboru pracovního postupu

V úložišti GitHub přidejte do adresáře .github/workflows nový soubor YAML. Zvolte smysluplný název souboru, který jasně indikuje, co má pracovní postup udělat. Další informace naleznete v souboru pracovního postupu.

Důležité

GitHub vyžaduje, aby se soubory složení pracovního postupu umístily do adresáře .github/workflows .

Soubory pracovního postupu obvykle definují složení jedné nebo více akcí GitHubu prostřednictvím .jobs.<job_id>/steps[*] Další informace najdete v syntaxi pracovního postupu pro GitHub Actions.

Vytvořte nový soubor s názvem build-and-test.yml, zkopírujte a vložte do něj následující obsah YML:

name: build and test

on:
  push:
  pull_request:
    branches: [ main ]
    paths:
    - '**.cs'
    - '**.csproj'

env:
  DOTNET_VERSION: '6.0.401' # The .NET SDK version to use

jobs:
  build-and-test:

    name: build-and-test-${{matrix.os}}
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macOS-latest]

    steps:
    - uses: actions/checkout@v3
    - name: Setup .NET Core
      uses: actions/setup-dotnet@v3
      with:
        dotnet-version: ${{ env.DOTNET_VERSION }}

    - name: Install dependencies
      run: dotnet restore
      
    - name: Build
      run: dotnet build --configuration Release --no-restore
    
    - name: Test
      run: dotnet test --no-restore --verbosity normal

V předchozím složení pracovního postupu:

Definuje name: build and test název, "build and test" se zobrazí v odznácích stavu pracovního postupu.
```
name: build and test
```
Uzel on označuje události, které aktivují pracovní postup:
```
on:
  push:
  pull_request:
    branches: [ main ]
    paths:
    - '**.cs'
    - '**.csproj'
```
- Aktivuje se, když push ve větvi dojde pull_request ke main změně souborů, které končí .cs nebo příponou souboru .csproj .
Uzel env definuje pojmenované proměnné prostředí (env var).
```
env:
  DOTNET_VERSION: '6.0.401' # The .NET SDK version to use
```
- Proměnná DOTNET_VERSION prostředí má přiřazenou hodnotu '6.0.401'. Na proměnnou prostředí se později odkazuje, aby se určila dotnet-versionactions/setup-dotnet@v3 akce GitHubu.

Uzel jobs sestaví kroky, které má pracovní postup provést.

jobs:
  build-and-test:

    name: build-and-test-${{matrix.os}}
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macOS-latest]

    steps:
    - uses: actions/checkout@v3
    - name: Setup .NET Core
      uses: actions/setup-dotnet@v3
      with:
        dotnet-version: ${{ env.DOTNET_VERSION }}

    - name: Install dependencies
      run: dotnet restore
      
    - name: Build
      run: dotnet build --configuration Release --no-restore
    
    - name: Test
      run: dotnet test --no-restore --verbosity normal

Existuje jedna úloha s názvem build-<os> , kde <os> je název operačního systému z objektu strategy/matrix. Prvky name a runs-on prvky jsou dynamické pro každou hodnotu v objektu matrix/os. Spustí se na nejnovějších verzích Ubuntu, Windows a macOS.
Akce actions/setup-dotnet@v3 GitHubu slouží k nastavení sady .NET SDK se zadanou verzí z DOTNET_VERSION proměnné prostředí.
Příkaz dotnet restore je volána.
Příkaz dotnet build je volána.
Příkaz dotnet test je volána.

Odznak Vytvoření stavu pracovního postupu

Pro úložiště GitHubu se běžně používá README.md soubor v kořenovém adresáři úložiště. Stejně tak je dobré hlásit nejnovější stav pro různé pracovní postupy. Všechny pracovní postupy můžou generovat odznáček stavu, který je vizuálně atraktivní v souboru README.md . Přidání odznaku stavu pracovního postupu:

V úložišti GitHub vyberte možnost Navigace v akcích .
Všechny pracovní postupy úložiště se zobrazují na levé straně, vyberte požadovaný pracovní postup a tlačítko se třemi tečkami (...).
- Tlačítko se třemi tečkami (...) rozbalí možnosti nabídky pro vybraný pracovní postup.
Vyberte možnost nabídky Vytvořit stavový odznáček.
Vyberte tlačítko Kopírovat odznáček Markdown.
Vložte Markdown do souboru README.md , uložte soubor, potvrďte a nasdílejte změny.