Repository‐Workflows

Build and Test

Was es tut:

Dieser Workflow ist so eingerichtet, dass er das Build- und Testen unseres Codes automatisch durchführt. Der Workflow wird sowohl bei jedem Push als auch bei jeder Pull-Request auf den main-Branch ausgelöst. Er aktualisiert, baut und testet den Code, um sicherzustellen, dass keine neuen Änderungen das aktuelle Code-Verzeichnis negativ beeinflussen.

Warum es das tut:

Dieser Workflow zielt darauf ab, Qualität und Stabilität im Projekt zu gewährleisten. Automatisierte Builds und Tests finden Fehler frühzeitig und verhindern, dass Commits bestehende Funktionen zerschlagen. Der Workflow beschleunigt die Entwicklung in Bezug auf Zeit und Qualität, da Fehler frühzeitig identifiziert und sofort behoben werden können.

Wie es getestet wurde:

Dieser Workflow wurde durch verschiedene Testfälle validiert, bei denen die Codeänderungen und Pull-Requests getestet wurden. Bei jeder Codeänderung wird dieser Workflow ausgelöst und die Konsistenz sowie Stabilität des Codes überprüft. Jeder Schritt des Build- und Testprozesses wird protokolliert, um die vollständige Integrität sicherzustellen.

Workflow Konfiguration:

name: Build and Test

# Für jeden Push und Pull Request auf main
on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  build:
    runs-on: windows-latest

    steps:
    # Checkout
    - name: Checkout code
      uses: actions/checkout@v4
    
    # .NET Setup
    - name: Setup .NET
      uses: actions/[email protected]
      with:
        dotnet-version: '8.0.x'
    
    # Restore
    - name: Restore dependencies
      run: dotnet restore src
    
    # Build
    - name: Build
      run: dotnet build src --no-restore
    
    # Testen
    - name: Run tests
      run: dotnet test src --no-restore --verbosity normal

Generate Doxygen Documentation

Was es tut:

Dieser Workflow ist so eingerichtet, dass er automatisch die Dokumentation des Codes generiert und auf GitHub Pages bereitstellt. Der Workflow wird sowohl bei jedem Push als auch bei jeder Pull-Request auf den main-Branch ausgelöst.

Warum es das tut:

Dieser Workflow zielt darauf ab, die Dokumentation stets aktuell und zugänglich zu halten, ohne dass manuelle Eingriffe erforderlich sind. Dies spart Zeit und reduziert Fehler, die durch veraltete Dokumentation entstehen können.

Wie es getestet wurde:

Dieser Workflow wurde durch das Erstellen von Test-Pushes oder Pull-Requests im main-Branch validiert. Dabei wurden die Schritte zur Dokumentationserstellung und -bereitstellung überprüft, um sicherzustellen, dass die Dokumentation erfolgreich auf GitHub Pages veröffentlicht wird.

Workflow Konfiguration:

name: Generate Doxygen Documentation

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  generate-docs:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Set up Doxygen
      run: |
        sudo apt-get update
        sudo apt-get install -y doxygen graphviz

    - name: Generate Documentation
      run: doxygen Doxyfile

    - name: Deploy
      uses: peaceiris/actions-gh-pages@v4
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./docs/html