Een GitHub Repo verbinden

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…

Voordat Orbit iets van GitHub kan implementeren, installeert u de Kapsule Orbit GitHub App op uw GitHub-account of organisatie en kiest u welke repositories deze kan zien. Deze gids helpt u door de installatie, repositoryselectie, projectcreatie, en wat u kunt doen als een repository die u verwacht niet verschijnt.

Voordat u begint

U hebt toestemming nodig om een GitHub App te installeren op het account of de organisatie die de repository bezit. Op een persoonlijk account gebeurt dit automatisch. Op een organisatie moet u eigenaar zijn, of moet een eigenaar uw installatieaanvraag goedkeuren vanuit de instellingen van de organisatie.

Stap 1: De Kapsule Orbit GitHub App installeren

Klik in KPanel op Orbit in de linker zijbalk.
Klik op Nieuw project.
Laat de modus op Git Repo importeren staan.
Klik bij stap 1 op GitHub verbinden.

U wordt naar GitHub gestuurd om de app Kapsule Orbit te installeren. GitHub vraagt waar u deze wilt installeren (uw persoonlijke account of een organisatie) en vervolgens of u Alle repositories of Alleen geselecteerde repositories wilt verlenen.

Kies Alleen geselecteerde repositories en vink alleen de repositories aan die u van plan bent in te zetten. U kunt later meer repositories toevoegen vanuit GitHub zonder de verbinding te verbreken of iets in Orbit opnieuw aan te maken, en het beperkt de reikwijdte van de integratie.

Als u klaar bent, stuurt GitHub u terug naar KPanel. Stap 1 toont nu Zojuist verbonden, en uw repositories worden geladen in stap 2.

Stap 2: Een repository selecteren

Uw toegankelijke repositories verschijnen in een lijst. Klik op Selecteren op de repository die u wilt implementeren. Privérepositories hebben een Privé-badge; Orbit implementeert zowel openbare als privérepositories.

Na selectie toont de repository een Geselecteerd-badge, en een Wijzigen-link laat u een ander kiezen.

Als een repository ontbreekt

Orbit kan alleen tonen wat de GitHub App kan zien. Als een repository die u verwacht niet daar is:

Klik op GitHub opnieuw verbinden bij stap 1 om het installatieproces opnieuw uit te voeren, of open rechtstreeks github.com/settings/installations.
Open de Kapsule Orbit-installatie en voeg de ontbrekende repository toe onder Repository-toegang.
Ga terug naar KPanel. De lijst wordt vernieuwd.

Als het paneel Geen repositories toegankelijk toont, is de app geïnstalleerd maar zijn geen repositories toegekend. Open de GitHub App-instellingen en verlenen toegang tot minstens één repository.

Andere veelvoorkomende oorzaken:

De repository behoort tot een organisatie waarop u de app niet hebt geïnstalleerd. Als u deze alleen op uw persoonlijke account installeert, worden organisatierepositories niet opgenomen.
Een organisatie-eigenaar heeft uw installatieaanvraag nog niet goedgekeurd. Tot dat moment bestaat de app maar ziet niets.
De repository is overgedragen of hernoemd nadat u de app hebt geïnstalleerd. Voer het installatieproces opnieuw uit om te vernieuwen wat Orbit kan zien.

Stap 3: Uw project configureren

Met een geselecteerde repository vraagt stap 3 om twee velden:

Veld	Wat het doet
Projectnaam	De weergavenaam in KPanel, bijvoorbeeld `my-app`
URL voor implementatie	Het subdomein onder `kaps.run`, dus `my-app` wordt `my-app.kaps.run`

Klik op Project aanmaken. Orbit klont de repository, plaatst uw eerste build in de wachtrij, en brengt u naar het projectoverzicht waar u de logstream kunt volgen.

De slug van de implementatie-URL wordt eenmaal bij het aanmaken ingesteld en kan later niet worden gewijzigd. Als u later een ander openbaar adres wilt, voegt u een aangepast domein toe in plaats van te proberen de slug te hernoemen. Zie Een aangepast domein aan uw project toevoegen.

Wat Orbit automatisch instelt

Het aanmaken van het project stelt push-to-deploy voor u in. Er is geen webhook om handmatig in te stellen:

Pushes naar uw productietak activeren een productie-implementatie.
Als Branch previews is ingeschakeld, worden pushes naar een ander tak gebouwd als een geïsoleerde preview op branch-<branch-name>.kaps.run. Zie Branch Preview Deployments in Orbit.
Pull request-activiteit wordt bijgehouden, dus een preview-implementatie toont het PR-nummer waartoe het behoort.
Het sluiten of mergen van een pull request pauzeert de preview ervan, en de opslag wordt binnen ongeveer een dag vrijgemaakt.

Implementaties controleren met GitHub Actions

Als u tests in GitHub Actions uitvoert, kunt u Orbit laten wachten tot ze klaar zijn. In Instellingen voert u onder CI-vereiste controles de exacte naam van de Actions-taken in, gescheiden door komma's, bijvoorbeeld build,test,lint. Alle benoemde controles moeten slagen voordat een push-geactiveerde productie-implementatie doorgaat. Een CI-fout annuleert de Orbit-implementatie automatisch.

Dit geldt alleen voor de productietak.

Opnieuw verbinden of uw installatie wijzigen

Om te wijzigen welke repositories Orbit kan zien:

Klik op Orbit en vervolgens op Nieuw project.
Klik bij stap 1 op Opnieuw verbinden om het installatieproces van de GitHub App opnieuw uit te voeren.

Of beheer de installatie rechtstreeks op github.com/settings/installations. Wijzigingen daar worden opgemerkt de volgende keer dat Orbit uw repositories opsomt.

GitHub verbreken

Klik bij stap 1 van Nieuw project op Verbreken.

Door de verbinding te verbreken, verbreekt u de koppeling tussen uw Kapsule-account en GitHub. Uw projecten en hun implementatiegeschiedenis blijven behouden, en de momenteel live implementatie blijft verkeer serveren, maar push-geactiveerde implementaties stoppen totdat u opnieuw verbinding maakt. Deploy hooks blijven werken, omdat zij de takhead ophalen via de providerverbinding: als de verbinding weg is, mislukt een hookaanroep met een fout in plaats van verouderde code in te zetten.

Gerelateerde onderwerpen

Uw project implementeren voor de volledige implementatiecyclus en de poorten die deze controleren
Uw buildopdracht en uitvoermap configureren als de eerste build mislukt of het verkeerde resultaat oplevert
Een GitLab-repository verbinden en Een Bitbucket-repository verbinden voor de andere providers