Orbit
Connessione di un repository GitHub
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…
Prima che Orbit possa distribuire qualcosa da GitHub, installi l'app Kapsule Orbit GitHub sul tuo account o organizzazione GitHub e scegli quali repository può visualizzare. Questa guida ti accompagna attraverso l'installazione, la selezione di un repository, la creazione del progetto e cosa fare quando un repository che ti aspetti non appare.
Prima di iniziare
Hai bisogno del permesso di installare un'app GitHub sull'account o organizzazione che possiede il repository. Su un account personale è automatico. Su un'organizzazione devi essere un proprietario oppure un proprietario deve approvare la tua richiesta di installazione dalle impostazioni dell'organizzazione.
Passaggio 1: Installa l'app Kapsule Orbit GitHub
- In KPanel, fai clic su Orbit nella barra laterale sinistra.
- Fai clic su New project.
- Lascia la modalità impostata su Import Git Repo.
- Al passaggio 1, fai clic su Connect GitHub.
Vieni inviato su GitHub per installare l'app Kapsule Orbit. GitHub chiede dove installarla (il tuo account personale o un'organizzazione) e poi se concedere All repositories o Only select repositories.
Scegli Only select repositories e seleziona solo i repository che intendi distribuire. Puoi aggiungerne altri in seguito da GitHub senza disconnetterti o ricreare nulla in Orbit, e mantiene il raggio d'azione dell'integrazione piccolo.
Quando finisci, GitHub ti rispedisce a KPanel. Il passaggio 1 ora mostra Just connected, e i tuoi repository si caricano nel passaggio 2.
Passaggio 2: Seleziona un repository
I tuoi repository accessibili appaiono come un elenco. Fai clic su Select su quello che vuoi distribuire. I repository privati hanno un badge Private; Orbit distribuisce repository pubblici e privati allo stesso modo.
Una volta selezionato, il repository mostra un badge Selected, e un collegamento Change ti permette di sceglierne uno diverso.
Se un repository manca
Orbit può solo elencare quello che l'app GitHub può visualizzare. Se un repository che ti aspetti non è lì:
- Fai clic su Reconnect GitHub al passaggio 1 per rieseguire il flusso di installazione, oppure apri direttamente github.com/settings/installations.
- Apri l'installazione di Kapsule Orbit e aggiungi il repository mancante sotto Repository access.
- Ritorna a KPanel. L'elenco si aggiorna.
Se il pannello mostra No repos accessible, l'app è installata ma non è stato concesso accesso a nessun repository. Apri le impostazioni dell'app GitHub e concedi l'accesso ad almeno uno.
Altre cause comuni:
- Il repository appartiene a un'organizzazione su cui non hai installato l'app. Installarla sul tuo account personale non copre i repository dell'organizzazione.
- Un proprietario dell'organizzazione non ha ancora approvato la tua richiesta di installazione. Fino a quando non lo fa, l'app esiste ma non visualizza nulla.
- Il repository è stato trasferito o rinominato dopo che hai installato l'app. Riesegui il flusso di installazione per aggiornare ciò che Orbit può visualizzare.
Passaggio 3: Configura il tuo progetto
Con un repository selezionato, il passaggio 3 chiede due campi:
| Campo | Cosa fa |
|---|---|
| Project Name | Il nome visualizzato in KPanel, ad esempio my-app |
| Deploy URL | Il sottodominio sotto kaps.run, quindi my-app diventa my-app.kaps.run |
Fai clic su Create project. Orbit clona il repository, mette in coda la tua prima build, e ti porta alla panoramica del progetto dove puoi guardare il flusso dei log.
Lo slug dell'URL di distribuzione viene impostato una volta durante la creazione e non può essere modificato in seguito. Se desideri un indirizzo pubblico diverso in seguito, collega un dominio personalizzato piuttosto che provare a rinominare lo slug. Vedi Adding a Custom Domain to Your Project.
Cosa Orbit configura automaticamente
La creazione del progetto attiva il push-to-deploy per te. Non c'è webhook da configurare manualmente:
- I push al tuo ramo di produzione mettono in coda una distribuzione di produzione.
- Se Branch previews è abilitato, i push su qualsiasi altro ramo creano un'anteprima isolata in
branch-<branch-name>.kaps.run. Vedi Branch Preview Deployments in Orbit. - L'attività delle pull request viene tracciata, quindi un'anteprima di distribuzione mostra il numero di PR a cui appartiene.
- La chiusura o l'unione di una pull request mette in pausa la sua anteprima, e l'archiviazione viene recuperata entro circa un giorno.
Limitare i deploy su GitHub Actions
Se esegui test in GitHub Actions puoi fare in modo che Orbit li attenda. In Settings, poi CI required checks, inserisci i nomi esatti dei job di Actions, separati da virgola, ad esempio build,test,lint. Tutti i controlli denominati devono passare prima che una distribuzione di produzione attivata da un push proceda. Un errore di CI annulla automaticamente il deploy di Orbit.
Questo si applica solo al ramo di produzione.
Riconnessione o modifica della tua installazione
Per cambiare quali repository Orbit può visualizzare:
- Fai clic su Orbit, poi New project.
- Al passaggio 1, fai clic su Reconnect per rieseguire il flusso di installazione dell'app GitHub.
Oppure gestisci l'installazione direttamente in github.com/settings/installations. Le modifiche lì vengono rilevate la prossima volta che Orbit elenca i tuoi repository.
Disconnessione da GitHub
Al passaggio 1 di New project, fai clic su Disconnect.
La disconnessione rimuove il collegamento tra il tuo account Kapsule e GitHub. I tuoi progetti e la loro cronologia di distribuzione vengono conservati, e la distribuzione attualmente live continua a servire il traffico, ma i deploy attivati da push si interrompono finché non ti riconnetti. I deploy hook continuano a funzionare, perché recuperano la testa del ramo attraverso la connessione del provider: se la connessione non c'è, una chiamata di hook non riesce con un errore piuttosto che distribuire codice non aggiornato.
Letture correlate
- Deploying Your Project per il ciclo di deploy completo e i gate che lo controllano
- Configuring Your Build Command and Output Directory se il primo build non riesce o serve la cosa sbagliata
- Connecting a GitLab Repo e Connecting a Bitbucket Repo per gli altri provider