MJWNA/github-repo-publisher

Was macht github-repo-publisher?

Codex-Skill zur Veröffentlichung vollständiger, gut dokumentierter und sicherer GitHub-Repositories.

Überblick

Dieses Skill ermöglicht einem KI-Agenten (z.B. Codex), vollständige GitHub-Repositories zu erstellen und zu veröffentlichen, die folgende Kriterien erfüllen:

• Vollständig: Enthält alle notwendigen Dateien wie README.md, LICENSE, .gitignore und ggf. Konfigurationsdateien.
• Gut dokumentiert: README.md ist aussagekräftig, beschreibt das Projekt, seine Nutzung und Einrichtung.
• Sicher: Beachtet Sicherheitsaspekte wie verschlüsselte Umgebungsvariablen, keine harten Zugangsdaten im Code, korrekte Zugriffsrechte.

Verwendung

1. Stelle sicher, dass der Agent Zugriff auf die GitHub-API hat (z.B. über ein persönliches Access Token mit Repository-Berechtigungen).
2. Der Agent erstellt basierend auf deiner Beschreibung ein lokales Repository-Verzeichnis oder eine Struktur.
3. Der Agent führt das Skill aus, um:
   • Ein neues Repository auf GitHub zu erstellen (öffentlich oder privat).
   • Lokale Dateien in das Repository zu committen.
   • Einen initialen Branch (z.B. main) zu erstellen.
   • Das gesamte Repository zu veröffentlichen.

Konfiguration

• GITHUB_TOKEN: Persönliches Access Token mit Repository-Schreibberechtigung (als Umgebungsvariable).
• REPO_NAME: Name des zu erstellenden Repositories (optional, kann auch direkt angegeben werden).
• REPO_VISIBILITY: public oder private (Standard ist public).

Beispiel

# Ein neues Repository mit einer README und Lizenz veröffentlichen
github-repo-publisher --name my-awesome-project --description "Ein Projekt, das großartige Dinge tut" --visibility public

Abhängigkeiten

• git (muss installiert sein)
• GitHub CLI (gh) oder direkte Nutzung der GitHub-API über curl / HTTP-Bibliotheken

Sicherheitshinweise

• Niemals sensible Daten (Passwörter, Tokens, Schlüssel) im Code oder in der README speichern. Nutze Umgebungsvariablen.
• Die .gitignore-Datei sollte automatisch relevante Build-Artefakte, Logs und temporäre Dateien ausschließen.
• Stelle sicher, dass nur autorisierte Benutzer Zugriff auf das Repository haben.

Lizenz

Dieses Skill wird unter der MIT-Lizenz bereitgestellt. Weitere Informationen findest du in der Datei LICENSE des Repositories.