GitHub Actions-Referenzkarte – Standardstruktur und eine Liste der nützlichsten Aktionen

GitHub Actions ist eine Automatisierungs- und CI/CD-Plattform innerhalb von GitHub, die verwendet wird, um Code basierend auf Ereignissen wie Pushes, Pull Requests oder Zeitplänen zu erstellen, zu testen und bereitzustellen.

Zusätzlich zu Standard-GitHub können Sie GitHub Actions auf einem selbst gehosteten Gitea-Server verwenden.

Actions erstrecken sich auf offizielle, Community- und Drittanbieter-Tools und unterstützen die Automatisierung von Builds und Tests bis hin zu Deployment, Release-Management, QA und Benachrichtigungen.

Diese Zusammenfassung behandelt die Struktur von GitHub Actions, eine kurze Beschreibung und die häufigsten Actions, die in Open-Source- und kommerziellen Workflows verwendet werden. Sie ist Teil von Entwickler-Tools: Der vollständige Leitfaden für moderne Entwicklungswerkzeuge.

Grundlegende Konfigurationsstruktur

GitHub Actions Workflows werden in YAML-Dateien definiert, die sich im Verzeichnis .github/workflows innerhalb des Repositories befinden.

name: Workflow Name
on:
  push:
    branches: [ main ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Node.js einrichten
        uses: actions/setup-node@v3
        with:
          node-version: '18'
      - name: Tests ausführen
        run: npm test

• Der on-Block definiert die Auslöseereignisse.
• Jeder job wird auf einem eigenen Runner ausgeführt.
• steps können Shell-Befehle ausführen oder wiederverwendbare Actions aufrufen.

Kernkomponenten von Workflows

Auslöseereignisse

• push
• pull_request
• schedule (unter Verwendung von Cron-Syntax)
• workflow_dispatch (manueller Auslöser, ermöglicht Eingabeparameter)
• release, issue, etc.

Beispiel:

on:
  push:
    branches: [ main ]
  workflow_dispatch:
    inputs:
      environment:
        description: 'Bereitstellungs-Umgebung'
        required: true
        default: 'production'
        type: string

Nützliche integrierte Actions

Action-Parameter

Allgemeine Parameter für jeden Action-Aufruf:

- name: Some Action or Step
  uses: owner/repo@ref
  with:
    param1: value
    param2: value
  env:
    ENV_VAR: value
  if: ${{ condition }}
  run: command_to_run
  shell: bash|pwsh|python|sh
  continue-on-error: true|false

• with: Argumente, die an die Action übergeben werden (siehe Action-Dokumentation für alle Optionen)
• env: Umgebungsvariablen für den Schritt
• if: Bedingte Ausführung
• run: Shell-Befehle (falls keine Action verwendet wird)
• shell: Shell, die zum Ausführen des Schritts verwendet wird
• continue-on-error: Weitermachen, auch wenn der Schritt fehlschlägt

Definition benutzerdefinierter Action-Eingaben

In Ihrer Action-Metadatei (action.yml):

inputs:
  example-input:
    description: 'Ein Beispiel-Eingabewert'
    required: false
    default: 'standard-wert'

Wenn in einem Workflow verwendet:

- uses: my/action@v1
  with:
    example-input: 'benutzerdefinierter-wert'

Zugriff als Umgebungsvariable INPUT_EXAMPLE_INPUT, wenn die Action ausgeführt wird.

Beispiel: Workflow mit manuellen Parametern

name: Deploy
on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Bereitstellungs-Umgebung'
        required: true
        default: 'production'
        type: string
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Code herausziehen
        uses: actions/checkout@v4
      - name: In Umgebung bereitstellen
        run: echo "Bereitstellung in ${{ github.event.inputs.environment }}"

Action-Marktplatz

• Tausende von wiederverwendbaren Actions sind im GitHub Marketplace verfügbar.
• Kategorien umfassen: Cloud-Bereitstellungen, Benachrichtigungstools, Testframeworks, Code-Analyse und mehr.
• Entdecken Sie: actions/checkout, actions/setup-node, docker/build-push-action, actions/cache, actions/upload-artifact und viele andere.

Schnelle Tipps

• Platzieren Sie Workflow-Dateien in .github/workflows.
• Verwenden Sie workflow_dispatch mit inputs für manuelle und parametrisierte Durchläufe.
• Verwenden Sie die cache-Action, um die Installation von Abhängigkeiten zu beschleunigen.
• Verwenden Sie die Job-matrix, um mehrere Betriebssystem-/Laufzeitversionen zu testen.
• Verwenden Sie Secrets für sensible Daten, referenziert als ${{ secrets.SECRET_NAME }}.

Dieses Cheatsheet deckt die Grundlagen der Verwendung, Konfiguration und Erweiterung von GitHub Actions für Automatisierung, CI/CD und mehr ab. Für weitere Details und Updates konsultieren Sie immer die offizielle GitHub-Dokumentation und Action-Repositories.

Häufige GitHub Actions

Hier ist eine praktische Liste häufig genutzter GitHub Actions, die bei der Automatisierung von CI/CD, Tests, Builds, Bereitstellungen und Workflow-Aufgaben helfen:

Kern-Offizielle Actions

Beliebte Community- und Drittanbieter-Actions

Testing, QA und Reporting Actions

Bereitstellungs- und Benachrichtigungs-Actions

Utility- und Workflow-Management-Actions

Wie man mehr findet

Es gibt viele GitHub Actions, die Workflow-Automatisierung ermöglichen, wie automatisiertes Testen, Bereitstellung in der Produktion, Benachrichtigungen und Integrationen mit anderen Diensten. Der GitHub Marketplace listet tausende Actions in Kategorien wie Testing, Sicherheit, Bereitstellung, Benachrichtigungen, Code-Qualität und Integrationen auf. Kuratierte Listen wie “Awesome Actions” sind ebenfalls großartig für Inspiration und Entdeckung.

Nützliche Links

• https://docs.github.com/actions
• https://github.com/marketplace
• https://docs.github.com/en/actions/get-started/quickstart
• https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
• GIT Cheatsheet
• Gitea - Installation und Test
• Backup und Wiederherstellung des Gitea-Servers
• Verwendung von Gitea Actions zur Bereitstellung einer Hugo-Website auf AWS S3
• Gitflow: Schritte, Alternativen, Vor- und Nachteile
• DevOps mit GitOps - Argo CD, Flux, Jenkins X, Weave GitOps und andere