Orbit
Verbindung mit einem GitHub-Repository
Before Orbit can deploy anything from GitHub you install the Kapsule Orbit GitHub App on your GitHub account or organisation and choose which repositories it can see. This guide walks through the…
Bevor Orbit etwas von GitHub bereitstellen kann, müssen Sie die Kapsule Orbit GitHub App auf Ihrem GitHub-Konto oder in Ihrer Organisation installieren und auswählen, welche Repositorys sie sehen darf. Dieses Handbuch führt Sie durch die Installation, die Auswahl eines Repositorys, die Erstellung des Projekts und erklärt, was zu tun ist, wenn ein erwartetes Repository nicht angezeigt wird.
Vorbemerkungen
Sie benötigen die Berechtigung, eine GitHub App auf dem Konto oder in der Organisation zu installieren, das bzw. die das Repository besitzt. Bei einem persönlichen Konto geschieht dies automatisch. Bei einer Organisation müssen Sie entweder Besitzer sein oder ein Besitzer muss Ihre Installationsanfrage in den Organisationseinstellungen genehmigen.
Schritt 1: Installieren Sie die Kapsule Orbit GitHub App
- Klicken Sie in KPanel auf Orbit in der linken Seitenleiste.
- Klicken Sie auf New project.
- Lassen Sie den Modus auf Import Git Repo eingestellt.
- Klicken Sie in Schritt 1 auf Connect GitHub.
Sie werden zu GitHub weitergeleitet, um die Kapsule Orbit App zu installieren. GitHub fragt, wo Sie die App installieren möchten (auf Ihrem persönlichen Konto oder in einer Organisation) und dann, ob Sie All repositories oder Only select repositories gewähren möchten.
Wählen Sie Only select repositories und aktivieren Sie nur die Repositorys, die Sie bereitstellen möchten. Sie können später weitere Repositorys von GitHub aus hinzufügen, ohne die Verbindung zu trennen oder etwas in Orbit neu zu erstellen, und dies begrenzt das Risiko der Integration.
Danach werden Sie von GitHub zu KPanel zurückgeleitet. Schritt 1 zeigt nun Just connected an, und Ihre Repositorys werden in Schritt 2 geladen.
Schritt 2: Wählen Sie ein Repository
Ihre zugänglichen Repositorys werden als Liste angezeigt. Klicken Sie auf Select für das Repository, das Sie bereitstellen möchten. Private Repositorys tragen ein Private Badge; Orbit stellt sowohl öffentliche als auch private Repositorys bereit.
Nach der Auswahl zeigt das Repository ein Selected Badge an, und ein Change Link ermöglicht es Ihnen, ein anderes auszuwählen.
Wenn ein Repository fehlt
Orbit kann nur auflisten, was die GitHub App sehen kann. Wenn ein erwartetes Repository nicht vorhanden ist:
- Klicken Sie auf Reconnect GitHub in Schritt 1, um den Installationsprozess erneut auszuführen, oder öffnen Sie direkt github.com/settings/installations.
- Öffnen Sie die Kapsule Orbit Installation und fügen Sie das fehlende Repository unter Repository access hinzu.
- Kehren Sie zu KPanel zurück. Die Liste wird aktualisiert.
Wenn das Panel No repos accessible anzeigt, ist die App installiert, aber es wurden ihr keine Repositorys gewährt. Öffnen Sie die GitHub App-Einstellungen und gewähren Sie Zugriff auf mindestens eines.
Weitere häufige Ursachen:
- Das Repository gehört zu einer Organisation, auf der Sie die App nicht installiert haben. Die Installation auf Ihrem persönlichen Konto deckt keine Organisationsrepositorys ab.
- Ein Organisationsbesitzer hat Ihre Installationsanfrage noch nicht genehmigt. Bis dahin existiert die App, sieht aber nichts.
- Das Repository wurde übertragen oder umbenannt, nachdem Sie die App installiert haben. Führen Sie den Installationsprozess erneut aus, um zu aktualisieren, was Orbit sehen kann.
Schritt 3: Konfigurieren Sie Ihr Projekt
Mit einem ausgewählten Repository fragt Schritt 3 nach zwei Feldern:
| Feld | Funktion |
|---|---|
| Project Name | Der Anzeigename in KPanel, zum Beispiel my-app |
| Deploy URL | Die Subdomain unter kaps.run, also my-app wird zu my-app.kaps.run |
Klicken Sie auf Create project. Orbit klont das Repository, stellt den ersten Build in die Warteschlange und bringt Sie zur Projektübersicht, wo Sie den Protokollstrom überwachen können.
Der Deploy URL Slug wird einmalig bei der Erstellung festgelegt und kann nachträglich nicht mehr geändert werden. Wenn Sie später eine andere öffentliche Adresse wünschen, fügen Sie stattdessen eine benutzerdefinierte Domain an, anstatt den Slug umzubenennen. Siehe Adding a Custom Domain to Your Project.
Was Orbit automatisch einrichtet
Die Projekterstellung verbindet Push-to-Deploy für Sie. Es gibt keine Webhook, die Sie manuell konfigurieren müssen:
- Pushes zu Ihrem Produktionszweig stellen eine Produktionsbereitstellung in die Warteschlange.
- Wenn Branch previews aktiviert ist, erstellen Pushes zu einem anderen Zweig eine isolierte Vorschau unter
branch-<branch-name>.kaps.run. Siehe Branch Preview Deployments in Orbit. - Die Pull Request-Aktivität wird verfolgt, sodass eine Vorschaubereitstellung die zugehörige PR-Nummer anzeigt.
- Das Schließen oder Mergen eines Pull Requests pausiert die Vorschau, und der Speicherplatz wird innerhalb von etwa einem Tag freigegeben.
Bereitstellungen über GitHub Actions schützen
Wenn Sie Tests in GitHub Actions ausführen, können Sie Orbit veranlassen, auf diese zu warten. Geben Sie unter Settings, dann CI required checks, die exakten Namen der Actions-Jobs durch Kommas getrennt ein, zum Beispiel build,test,lint. Alle benannten Checks müssen bestanden sein, bevor eine durch Push ausgelöste Produktionsbereitstellung fortschreitet. Ein CI-Fehler bricht die Orbit-Bereitstellung automatisch ab.
Dies gilt nur für den Produktionszweig.
Verbindung erneut herstellen oder Installation ändern
Um zu ändern, welche Repositorys Orbit sehen kann:
- Klicken Sie auf Orbit, dann auf New project.
- Klicken Sie in Schritt 1 auf Reconnect, um den GitHub App-Installationsprozess erneut auszuführen.
Oder verwalten Sie die Installation direkt unter github.com/settings/installations. Änderungen dort werden beim nächsten Auflisten Ihrer Repositorys durch Orbit berücksichtigt.
GitHub trennen
Klicken Sie in Schritt 1 von New project auf Disconnect.
Das Trennen entfernt die Verbindung zwischen Ihrem Kapsule-Konto und GitHub. Ihre Projekte und der Bereitstellungsverlauf werden beibehalten, und die aktuelle Live-Bereitstellung versorgt den Datenverkehr weiterhin, aber Push-ausgelöste Bereitstellungen werden unterbrochen, bis Sie die Verbindung erneut herstellen. Deploy Hooks funktionieren weiterhin, da sie den Branch Head über die Provider-Verbindung abrufen: Wenn die Verbindung weg ist, schlägt ein Hook-Aufruf mit einem Fehler fehl, anstatt veralteten Code bereitzustellen.
Weiterführende Artikel
- Deploying Your Project für den vollständigen Bereitstellungszyklus und die Gates, die ihn steuern
- Configuring Your Build Command and Output Directory falls der erste Build fehlschlägt oder das Falsche bereitstellt
- Connecting a GitLab Repo und Connecting a Bitbucket Repo für die anderen Provider