github/create-github-action-workflow-spezifikation

Was macht create-github-action-workflow-spezifikation?

Erstellt eine formale Spezifikation für einen bestehenden GitHub Actions CI/CD-Workflow, optimiert für KI-Nutzung und Workflow-Wartung.

Beschreibung

Dieses Skill analysiert eine vorhandene GitHub Actions-Workflow-Datei (.github/workflows/*.yml) und generiert eine formale Spezifikation, die den Zweck, die Struktur und das Verhalten des Workflows klar dokumentiert. Die Spezifikation ist so gestaltet, dass sie sowohl von Menschen als auch von KI-Assistenten leicht gelesen und verstanden werden kann, und sie dient als zentrale Referenz für die Workflow-Wartung und -Optimierung.

Verwendung

1. Stelle sicher, dass der Ziel-Workflow im Repository vorhanden ist.
2. Führe den folgenden Befehl aus:

claude code --skill create-github-action-workflow-specification

3. Gib den Pfad zur Workflow-Datei an, wenn du dazu aufgefordert wirst.

Ausgabe

Das Skill generiert eine Spezifikationsdatei im Format SPEC-<workflow-name>.md im Stammverzeichnis des Repositorys. Die Spezifikation enthält:

• Überschrift: Name und Zweck des Workflows
• Trigger: Ereignisse, die den Workflow auslösen
• Job-Matrix: Liste der Jobs mit Abhängigkeiten
• Schritte: Detailierte Beschreibung jedes Schritts inklusive erwarteter Ergebnisse
• Umgebungsvariablen und Geheimnisse: Alle verwendeten Variablen und deren Zweck
• Abhängigkeiten: Externe Aktionen und Dienste

Beispiel

Für einen Workflow ci.yml könnte die Ausgabe wie folgt aussehen:

# SPEC-ci

## Zweck
Führt Tests und Linting für Pull-Requests und Commits im `main`-Branch durch.

## Trigger
- `pull_request`
- `push`
  - Branches:
    - `main`

## Jobs

### test

- **Abhängigkeiten**: Keine
- **Schritte**:
  1. `actions/checkout@v4` – Repository auschecken
  2. `actions/setup-node@v4` – Node.js einrichten
  3. `npm ci` – Abhängigkeiten installieren
  4. `npm test` – Tests ausführen

### lint

- **Abhängigkeiten**: Keine
- **Schritte**:
  1. `actions/checkout@v4` – Repository auschecken
  2. `actions/setup-node@v4` – Node.js einrichten
  3. `npm ci` – Abhängigkeiten installieren
  4. `npm run lint` – Linting ausführen

Unterstützte Plattformen

Dieses Skill kann in jeder Umgebung verwendet werden, die GitHub Actions unterstützt, und ist mit KI-Assistenten wie Claude Code, Cursor und Codex kompatibel.

Fehlerbehebung

• Workflow nicht gefunden: Stelle sicher, dass der Pfad zur YAML-Datei korrekt ist.
• Ungültige YAML-Syntax: Überprüfe die Workflow-Datei auf Syntaxfehler.
• Fehlende Berechtigungen: Stelle sicher, dass der Zugriff auf das Repository besteht.