Git-Integration Übersicht - Archyl Docs

Verbinden Sie Ihre Git-Repositories, um KI-gestützte Architekturentdeckung zu ermöglichen

Git-Integration Übersicht

Die Verbindung Ihres Git-Repositories mit Archyl ermöglicht KI-gestützte Architekturentdeckung und hält Ihre Dokumentation mit Ihrem tatsächlichen Code synchron.

Unterstützte Anbieter

Archyl unterstützt alle großen Git-Hosting-Plattformen:

Cloud-Anbieter

Anbieter OAuth Funktionen
GitHub Ja Volle Unterstützung
GitLab Ja Volle Unterstützung
Bitbucket Ja Volle Unterstützung

Selbst-gehostet

Anbieter Auth-Methode Funktionen
GitHub Enterprise Token Volle Unterstützung
GitLab Self-Managed Token Volle Unterstützung
Gitea Token Volle Unterstützung
Azure DevOps Token Volle Unterstützung

Ein Repository Verbinden

Schritt 1: Zu Projekteinstellungen Navigieren

  1. Öffnen Sie Ihr Projekt
  2. Klicken Sie auf Einstellungen
  3. Gehen Sie zum Tab "Repository"

Schritt 2: Anbieter Wählen

  1. Klicken Sie auf "Repository verbinden"
  2. Wählen Sie Ihren Git-Anbieter
  3. Autorisieren Sie Archyl (für OAuth-Anbieter)

Schritt 3: Repository Auswählen

  1. Durchsuchen Sie Ihre verfügbaren Repositories
  2. Wählen Sie das zu verbindende Repository
  3. Wählen Sie den Standard-Branch
  4. Klicken Sie auf "Verbinden"

Authentifizierung

OAuth (Empfohlen)

Für GitHub, GitLab und Bitbucket Cloud:

  1. Klicken Sie auf "Mit [Anbieter] verbinden"
  2. Autorisieren Sie Archyl im Popup
  3. Wählen Sie Repositories für den Zugriff aus

OAuth-Tokens werden sicher gespeichert und automatisch aktualisiert.

Personal Access Tokens

Für selbst-gehostete oder Enterprise-Anbieter:

  1. Generieren Sie einen Token bei Ihrem Git-Anbieter
  2. Erforderliche Bereiche: repo (Lesezugriff)
  3. Geben Sie den Token in Archyl ein

Repository-Zugriff

Was Archyl Liest

Während der KI-Entdeckung liest Archyl:

  • Dateistruktur und -namen
  • Quellcode-Inhalt
  • Konfigurationsdateien (package.json, go.mod, etc.)
  • README-Dateien

Was Archyl Niemals Zugreift

  • Umgebungsdateien (.env)
  • Credentials oder Secrets
  • Git-Historie
  • Andere Branches (außer explizit ausgewählt)

Mehrere Repositories

Verbinden Sie mehrere Repositories mit einem einzelnen Projekt:

Monorepo

Für Monorepos, verbinden Sie einmal und geben Sie Pfade an:

/services/api
/services/web
/packages/shared

Multi-Repo

Für separate Repositories:

  1. Verbinden Sie jedes Repository
  2. Ordnen Sie Systemen oder Containern zu
  3. Die Entdeckung läuft über alle Repos

Webhooks (Demnächst)

Automatische Synchronisation bei Push:

  • Entdeckung bei Code-Änderungen auslösen
  • Architektur automatisch aktualisieren
  • Dokumentation aktuell halten

Fehlerbehebung

Autorisierung Fehlgeschlagen

  • Prüfen Sie, ob Ihr Token die erforderlichen Berechtigungen hat
  • Stellen Sie sicher, dass die OAuth-App autorisiert ist
  • Versuchen Sie, sich erneut zu verbinden

Repository Nicht Gefunden

  • Verifizieren Sie, dass Sie Zugriff auf das Repository haben
  • Prüfen Sie die Repository-URL
  • Stellen Sie sicher, dass der Branch existiert

Entdeckungsfehler

  • Prüfen Sie ausgeschlossene Pfade
  • Reduzieren Sie Nebenläufigkeitseinstellungen
  • Überprüfen Sie KI-Anbieter-Limits