Orbit
Distribuzioni di anteprima dei branch in Orbit
Branch previews build every non-production, non-staging branch you push to its own isolated URL, so you can click through a change in a real environment before it merges. This guide covers turning…
Abilitazione delle Preview di Branch
- Apri il tuo progetto in Orbit.
- Apri la scheda Settings.
- Trova la sezione Runtime e attiva Branch previews.
Una volta abilitata, ogni push a un branch che non sia il tuo branch di produzione né il tuo branch di staging attiva una build e la distribuisce nel suo ambiente di preview isolato.
Le branch preview sono un toggle per progetto, non un componente aggiuntivo a pagamento. Sono disponibili su tutti i piani Orbit, incluso il piano Launch gratuito. Quello che differisce in base al piano è quanti ambienti può avere un singolo progetto contemporaneamente: Launch consente 2 (produzione più una preview), Liftoff 4 e Apex 11. Una volta che un progetto raggiunge il limite di ambienti, ulteriori branch non otterranno la loro preview finché non ne elimini una.
URL di Preview
Una preview ottiene un hostname derivato dal nome del suo branch: il nome è convertito in minuscolo, ogni carattere che non è una lettera, una cifra o un trattino diventa un trattino, le sequenze di trattini si comprimono, e il risultato è troncato a 48 caratteri e preceduto da branch-.
| Branch | Preview hostname |
|---|---|
redesign | branch-redesign.kaps.run |
feat/new-checkout | branch-feat-new-checkout.kaps.run |
JB/Fix_Cart | branch-jb-fix-cart.kaps.run |
Gli URL di preview sono raggiungibili pubblicamente da chiunque abbia il link. Non sono indicizzati né pubblicizzati, ma non sono controllati dall'accesso. Non utilizzare una preview per revisionare nulla che non deve uscire dal tuo team, e non puntare una preview a dati di produzione. Se hai bisogno di un ambiente di pre-produzione protetto, utilizza invece un ambiente di staging: lo staging supporta una password e una lista di indirizzi IP consentiti sotto Settings, nelle sezioni Staging: access protection e Staging: IP allowlist.
Dove Appaiono le Preview
La scheda Overview del progetto ha una sezione Preview deployments che elenca ogni preview attiva. Ogni riga mostra:
- Il nome del branch e un badge PR #number che collega alla pull request quando il branch ne ha una aperta
- Lo stato attuale (QUEUED, BUILDING, o live)
- Da quanto tempo è stata distribuita
- Un link per aprire l'URL di preview
- View logs per aprire la pagina di dettaglio della distribuzione
- Un pulsante di eliminazione
Ogni preview è un ambiente completamente isolato con il suo URL, la sua build e le sue variabili di ambiente. Nulla di ciò che fa può influire sulla produzione.
La scheda Branches del progetto fornisce le stesse informazioni organizzate per branch, il che è più facile da scansionare quando hai diverse aperte contemporaneamente.
Variabili di Ambiente nelle Preview
Questa è la parte che vale la pena fare bene. Una variabile con scope All environments (project-wide) viene iniettata nelle build di preview, e un URL di preview è pubblico.
- Mantieni le credenziali di produzione scoped al tuo ambiente di produzione soltanto.
- Dai alle preview le credenziali in modalità test o sandbox per i servizi di terze parti.
- Non lasciare mai un URL di database di produzione o una chiave di pagamento live con scope project-wide.
La meccanica completa, incluso come aggiungere una variabile solo per la produzione e come funziona l'ereditarietà dello staging, si trova in Setting Environment Variables Per Environment.
Build Log per una Preview
Fai clic su View logs accanto a qualsiasi preview per aprire la sua pagina di dettaglio della distribuzione. Le preview ricevono lo stesso trattamento delle distribuzioni di produzione: log di build in streaming completo, fasi di build, commit e autore, dimensione dell'artefatto, cache hit o cold build, framework rilevato e package manager, e il pulsante di diagnosi AI quando una build fallisce.
Eliminazione di una Preview
Fai clic sul pulsante di eliminazione nella riga di preview e conferma.
L'eliminazione di una preview rimuove l'ambiente e l'intera cronologia della build, non solo la distribuzione corrente. Non può essere annullata. Il branch stesso rimane intatto, quindi eseguire il push su di esso di nuovo crea una preview fresca da zero, senza cronologia e con una cache di build fredda.
Pulizia Automatica
Non devi pulire dopo te stesso.
- Quando una pull request viene chiusa o unita, il suo ambiente di preview viene messo in pausa immediatamente e smette di servire. I visitatori ricevono un 404 invece di una build obsoleta.
- L'eliminazione di un branch mette in pausa la preview di quel branch allo stesso modo.
- Le preview in pausa vengono raccolte come garbage circa un giorno dopo: i tarball di origine, gli artefatti di build e le cache di build vengono eliminati e l'ambiente viene archiviato.
Puoi anche far scadere le preview secondo una pianificazione. In Settings, trova Preview expiry e scegli Never, 7, 14, 30 o 60 giorni. Le preview più vecchie di quanto specificato vengono messe in pausa automaticamente e pulite entro 24 ore.
Su un repository trafficato, imposta Preview expiry a 14 o 30 giorni. Ogni preview attiva conta rispetto al limite di ambienti del tuo progetto, e quelle scadute sono il motivo solito per cui un nuovo branch non ottiene silenziosamente una preview.
Approvazione e Preview
Se Require approval for production è abilitato sotto Deploy protection, si applica solo alla produzione. Le build di preview non vengono trattenute per l'approvazione.
Per impedire a una preview specifica di distribuire ulteriori modifiche senza eliminarla, metti in pausa l'ambiente dalla scheda Environments. I nuovi deploy a un ambiente in pausa vengono saltati finché non lo riprendi.
Risoluzione dei Problemi
Un branch è stato eseguito il push ma non è apparsa alcuna preview. Verifica, in ordine: Branch previews è attivo in Settings, quindi Runtime? Il branch è davvero il tuo branch di staging (lo staging distribuisce a staging, non a una preview)? Il branch corrisponde a uno dei tuoi Branch ignore patterns, ad esempio dependabot/*? Il progetto è già al limite di ambienti per il tuo piano?
La preview è stata costruita ma mostra un 404. La build è riuscita ma la directory di output è probabilmente sbagliata per questo branch. Controlla Output directory in Settings, e ricorda che un branch può cambiare l'output di build senza cambiare l'impostazione. Vedi Configuring Your Build Command and Output Directory.
La preview mostra un commit più vecchio. L'esecuzione del push di un nuovo commit mentre una build per lo stesso branch è ancora in esecuzione annulla la build in corso e ne avvia una nuova. Se vedi una distribuzione annullata seguita da una in esecuzione, è previsto. Attendi la seconda build.
La preview di una PR chiusa è ancora raggiungibile. La pausa avviene sull'evento webhook. Se la connessione del provider era disconnessa quando hai chiuso la PR, l'evento non è mai arrivato. Elimina manualmente la preview dalla scheda Overview.
Letture Correlate
- Deploying Your Project
- Setting Environment Variables Per Environment
- Orbit Plan Limits per l'assegnazione di ambienti su ogni piano