Skip to content
Cedrik Hoffmann edited this page Aug 4, 2024 · 2 revisions

GitHub Actions Workflows

In diesem Wiki-Eintrag werden wir eine Übersicht über spezifische GitHub Actions Workflows bereitstellen, die in unserem Projekt verwendet werden. Nachfolgend finden sich Details zu den spezifischen Workflows:

build-and-push-develop.yaml

Zweck

Automatisiert den Build- und Push-Prozess für den develop Branch.

Funktionsweise:

  • Trigger: Aktiviert bei jedem Push in den develop Branch.
  • Hauptaufgaben:
    • Baut das Projekt.
    • Pushed das erfolgreich gebaute Artefakt in die GitHub Artefakt-Repository.

build-and-test-on-pr.yaml

Zweck

Stellt sicher, dass Pull Requests (PRs) gebaut und getestet werden, bevor sie in den Hauptbranch gemerged werden.

Funktionsweise

  • Trigger: Aktiviert bei der Erstellung eines neuen Pull Requests gegen den develop Branch.
  • Hauptaufgaben:
    • Baut den Stand des PRs.
    • Führt alle definierten Tests aus, um die Integrität des Codes zu gewährleisten.

create-pr-on-backend-api-change.yaml

Zweck

Automatisiert die Erstellung von Pull Requests bei Änderungen am Backend oder der API.

Funktionsweise

  • Trigger: Aktiviert bei Änderungen im der API Definition vom Backend, wird vom Backend Workflow angestoßen
  • Hauptaufgaben:
    • Erstellt automatisch einen neuen Pull Request mit den vorgenommenen Änderungen.
    • Soll sicherstellen, das Änderungen an der API im Backend mit dem Frontend kompatible sind

notify-on-reviewer-needed.yaml

Zweck

Sendet Benachrichtigungen in Discord, wenn ein Pull Request Reviewer benötigt. Wird angestoßen, wenn das Tag need-reviewer im PR gesetzt wird.

Funktionsweise

  • Trigger: Aktiviert, wenn ein Pull Request erstellt und der Tag need-reviewer gesetzt wird.
  • Hauptaufgaben:
    • Sendet eine Benachrichtigung in Discord an ein channel, um über den Review-Bedarf zu informieren.