Zum Inhalt springen

PlaidCloud Git-Verbindung

Eine PlaidCloud Git-Verbindung verweist einen Workflow – oder den Build einer Server-Panel-App – auf ein Repository auf dem verwalteten Git-Server Ihres Workspace. Da dieser Git-Server für Sie unter git.<your-workspace>.plaid.cloud gehostet wird und Sie bereits über Ihre normale PlaidCloud-Anmeldung angemeldet sind, ist das Verbindungsformular deutlich einfacher als das eines externen Git-Anbieters: Sie müssen keine Server-URL eingeben und keinen Benutzernamen, kein Token und keinen SSH-Schlüssel verwalten.

Verwenden Sie eine PlaidCloud Git-Verbindung immer dann, wenn das Repository, aus dem Sie lesen möchten, in PlaidCloud Git liegt – dem integrierten Git-Dienst Ihres Workspace – und nicht bei einem externen Anbieter. Der häufigste Einsatz ist die Automatisierung von Builds für Server-Panel-Apps oder Dash-Apps aus einem verwalteten Repository: Ein Push auf einen Branch baut die App neu und stellt sie erneut bereit, ohne dass ein externes GitHub-Konto oder ein persönliches Zugriffstoken beteiligt ist.

Für ein Repository, das bei einem externen Dienst gehostet wird – GitHub, GitLab, Bitbucket, Forgejo oder Gitea –, verwenden Sie stattdessen eine externe Git-Verbindung. Diese behalten das vollständige Formular mit Server-URL, Benutzer-/Token- oder SSO-Authentifizierung sowie den Registerkarten SSL und SSH.

  1. Öffnen Sie Tools > Connections
  2. Klicken Sie auf New Connection und wählen Sie im Menü PlaidCloud Git
  3. Füllen Sie das vereinfachte Formular aus:
    • Kontoname – ein Anzeigename für die Verbindung
    • Notiz – ein optionaler Hinweis, wofür die Verbindung gedacht ist
    • Repository – klicken Sie auf Refresh, um die Repositorys aufzulisten, die Ihr Workspace erreichen kann, und wählen Sie dann eines aus (zum Beispiel Ihr udfs- oder apps-Repository). Sie wählen es aus der Liste aus, statt den Pfad einzutippen.
    • Standardbranch – wählen Sie aus der Liste der Branches im ausgewählten Repository den Branch, der standardmäßig gelesen wird
    • Startpfad – durchsuchen Sie optional das Repository und wählen Sie einen Ordner, um jede Dateisuche auf einen Unterordner zu beschränken; lassen Sie das Feld leer, um das gesamte Repository zu verwenden
  4. Legen Sie die Verwendung fest – Active, um die Verbindung zu aktivieren, und Read Only, wenn die Verbindung nie schreiben soll
  5. Legen Sie das Sicherheitsmodell fest – wer im Workspace die Verbindung verwenden darf
  6. Klicken Sie auf Create, um zu speichern

Das ist das gesamte Formular. Anders als bei einem externen Git-Anbieter gibt es keine Server-URL, keine Registerkarte für die Authentifizierung und keine SSL- oder SSH-Konfiguration – all das wird für Sie erledigt.

Das Security Model legt fest, wer im Workspace die Verbindung verwenden darf:

Option Wer die Verbindung verwenden kann
Privat (nur Eigentümer) Nur die Eigentümer.
Nur bestimmte Mitglieder Die Eigentümer plus eine ausdrückliche Liste von Mitgliedern.
Nur bestimmte Sicherheitsgruppen Die Eigentümer plus Mitglieder benannter Sicherheitsgruppen.
Alle Arbeitsbereichsmitglieder Alle im Workspace.

Für Specific Members Only oder Specific Security Groups Only erteilen Sie den Zugriff nach dem Speichern über das Menü Actions der Liste. Die gemeinsamen Grundlagen für Verbindungen finden Sie unter Eine Verbindung erstellen und verwalten.

Jedes Repository, das PlaidCloud für Sie erstellt, ist für jedes angemeldete Mitglied Ihres Workspace lesbar. Dazu gehören die Repositorys hinter Ihren Panel- und Dash-Apps sowie die integrierten Repositorys apps und udfs. Wer nicht angemeldet ist, kann sie nicht lesen.

Deshalb können Mitglieder Apps öffnen und erneut veröffentlichen und ein Repository für eine PlaidCloud Git-Verbindung auswählen, ohne dass pro Repository etwas eingerichtet werden muss.

Ein Git-Administrator kann ein Repository in der Git-Oberfläche privat machen. Ein privates Repository ist nicht mehr für jedes Mitglied sichtbar. Daher gilt:

  • Es erscheint nicht in der Repository-Liste bei PlaidCloud Git-Verbindungen.
  • Git-basierter UDF-Code kann daraus nicht gelesen werden, sodass eine in einem privaten Repository gespeicherte Git-basierte UDF nicht ausgeführt wird.
  • Mitglieder können daraus keine App veröffentlichen.

Wenn Sie ein privates Repository als Quelle verwenden möchten, erstellen Sie stattdessen eine externe Git-Verbindung mit eigenem Zugriffstoken.

Panel-App- und Dash-App-Builds aus verwaltetem Git automatisieren

Abschnitt betitelt „Panel-App- und Dash-App-Builds aus verwaltetem Git automatisieren“

Eine Server-Panel-App oder eine Dash-App wird aus einem Git-Branch gebaut und bei jedem Push auf diesen Branch automatisch neu gebaut. Wenn Sie sie auf eine PlaidCloud Git-Verbindung verweisen, bleibt der gesamte Kreislauf innerhalb Ihres Workspace – ohne externen Host und ohne persönliches Zugriffstoken, das Sie gültig halten müssen.

  1. Pushen Sie Ihre App in ein Repository auf dem PlaidCloud Git-Server Ihres Workspace – eine .py-Datei als Einstiegspunkt (bei Panel ruft sie .servable() auf; bei Dash stellt sie server = app.server bereit) und optional eine requirements.txt im Stammverzeichnis des Repositorys oder neben Ihrem Einstiegspunkt. Das Repository-Layout finden Sie unter Eine Panel-App erstellen oder Eine Dash-App aus PlaidCloud Git bereitstellen.
  2. Erstellen Sie eine PlaidCloud Git-Verbindung, deren Repository dieses Repository ist, und folgen Sie dabei den obigen Schritten.
  3. Wählen Sie unter Apps Neue App > Serverbasiert oder Dash-App und legen Sie unter Git-Verbindung und Veröffentlichungsüberwachung fest:
    • Git-Verbindung – wählen Sie die soeben erstellte PlaidCloud Git-Verbindung
    • Branch – der Branch, aus dem gebaut wird; Pushes darauf bauen die App neu und stellen sie erneut bereit
    • Einstiegspunkt – die .py-Datei, die die App bereitstellen soll
  4. Schließen Sie den Veröffentlichungsdialog ab und klicken Sie auf Veröffentlichen.

Ab dann baut jeder Push auf diesen Branch auf Ihrem verwalteten Git-Server die App neu – ein durchgängig automatisierter Build, der PlaidCloud nie verlässt.