Orbit
Branch Preview Deployments 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…
Branch previews bouwen elke niet-productie-, niet-staging-branch die je pusht naar zijn eigen geïsoleerde URL, zodat je een wijziging in een echte omgeving kunt testen voordat deze merged. Deze gids behandelt het inschakelen ervan, waar de URL's vandaan komen, hoe previews opgeruimd worden, en hoe je voorkomt dat preview builds productiegeheimen lekken.
Branch Previews inschakelen
- Open je project in Orbit.
- Open het tabblad Settings.
- Zoek de sectie Runtime en zet Branch previews aan.
Zodra ingeschakeld, triggert elke push naar een branch die noch je productie-branch noch je staging-branch is een build en implementeert deze in zijn eigen preview-omgeving.
Branch previews zijn een toggle per project, geen betaalde add-on. Ze zijn beschikbaar op elk Orbit-plan, inclusief het gratis Launch-plan. Wat per plan verschilt, is hoeveel omgevingen een enkel project tegelijk kan hebben: Launch staat 2 toe (productie plus één preview), Liftoff 4, en Apex 11. Zodra een project zijn omgevingslimiet bereikt, krijgen verdere branches geen eigen preview totdat je er één verwijdert.
Preview-URL's
Een preview krijgt een hostnaam afgeleid van zijn branchnaam: de naam wordt kleine letters, elk teken dat geen letter, cijfer of koppelteken is, wordt een koppelteken, series koppeltekens worden samengevouwen, het resultaat wordt afgekapt tot 48 tekens en voorafgegaan door 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 |
Preview-URL's zijn openbaar bereikbaar voor iedereen die de link heeft. Ze worden niet geïndexeerd of gepromoot, maar ze zijn ook niet toegangsgecontroleerd. Gebruik geen preview om iets te beoordelen dat je team niet mag verlaten, en wijs een preview niet naar productiegegevens. Als je een beveiligde pre-productieomgeving nodig hebt, gebruik in plaats daarvan een staging-omgeving: staging ondersteunt een wachtwoord en een IP-allowlist onder Settings, in de secties Staging: access protection en Staging: IP allowlist.
Waar previews verschijnen
Het tabblad Overview van het project heeft een sectie Preview deployments met alle actieve previews. Elke rij toont:
- De branchnaam en een PR #number-badge die naar de pull request linkt wanneer de branch er één open heeft
- De huidige status (QUEUED, BUILDING, of live)
- Hoe lang geleden het is geïmplementeerd
- Een link om de preview-URL te openen
- View logs om de implementatiedetailpagina te openen
- Een verwijderknop
Elke preview is een volledig geïsoleerde omgeving met zijn eigen URL, zijn eigen build en zijn eigen omgevingsvariabelen. Niets wat het doet, kan productie beïnvloeden.
Het tabblad Branches van het project geeft dezelfde informatie per branch georganiseerd, wat gemakkelijker is om te scannen wanneer je er meerdere tegelijk open hebt.
Omgevingsvariabelen in previews
Dit is het onderdeel dat je goed moet aanpakken. Een variabele met bereik All environments (project-wide) wordt in preview builds geïnjecteerd, en een preview-URL is openbaar.
- Houd productiereferenties scoped alleen naar je productieomgeving.
- Geef previews test-mode of sandbox-referenties voor third-party-services.
- Laat nooit een productiedatabase-URL of een live-betalingssleutel in project-wide-bereik.
De volledige mechanica, inclusief hoe je een alleen-productie-variabele toevoegt en hoe staging-overerving werkt, staat in Setting Environment Variables Per Environment.
Build logs voor een preview
Klik View logs naast een preview om de implementatiedetailpagina te openen. Previews krijgen dezelfde behandeling als productie-implementaties: volledig streaming build log, build-fasen, commit en auteur, artefactgrootte, cache hit of cold build, gedetecteerd framework en package manager, en de AI-diagnosisknop wanneer een build mislukt.
Een preview verwijderen
Klik op de verwijderknop op de preview-rij en bevestig.
Het verwijderen van een preview verwijdert de omgeving en de volledige build-historie, niet alleen de huidige implementatie. Dit kan niet ongedaan gemaakt worden. De branch zelf wordt niet aangeraakt, dus als je er opnieuw naar pusht, wordt een nieuwe preview helemaal opnieuw gemaakt, zonder historie en met een cold build cache.
Automatische opruiming
Je hoeft niet achter jezelf op te ruimen.
- Wanneer een pull request wordt gesloten of merged, wordt de preview-omgeving ervan onmiddellijk onderbroken en stopt deze met serveren. Bezoekers krijgen een 404 in plaats van een verouderde build.
- Het verwijderen van een branch onderbreekt de preview van die branch op dezelfde manier.
- Onderbroken previews worden ongeveer een dag later opgeruimd: de source tarballs, build artefacten en build caches worden verwijderd en de omgeving wordt gearchiveerd.
Je kunt previews ook volgens een schema laten verlopen. Ga in Settings naar Preview expiry en kies Never, 7, 14, 30 of 60 dagen. Previews die ouder zijn dan dat, worden automatisch onderbroken en opgeruimd binnen 24 uur.
Stel op een drukke repository Preview expiry in op 14 of 30 dagen. Elke actieve preview telt mee voor de omgevingslimiet van je project, en verlopen previews zijn meestal de reden waarom een nieuwe branch stil geen preview krijgt.
Goedkeuring en previews
Als Require approval for production is ingeschakeld onder Deploy protection, is dit alleen van toepassing op productie. Preview builds worden niet ingehouden voor goedkeuring.
Om te voorkomen dat een specifieke preview verdere wijzigingen implementeert zonder deze te verwijderen, onderbreek je de omgeving via het tabblad Environments. Nieuwe implementaties naar een onderbroken omgeving worden overgeslagen totdat je deze hervatting.
Problemen oplossen
Een branch is gepusht maar er is geen preview verschenen. Controleer, in volgorde: staat Branch previews aan in Settings, dan Runtime? Is de branch werkelijk je staging branch (staging implementeert naar staging, niet naar een preview)? Overeenkomt de branch met een van je Branch ignore patterns, bijvoorbeeld dependabot/*? Heeft het project al zijn omgevingslimiet bereikt voor je plan?
De preview is gebouwd maar toont een 404. De build is geslaagd maar de output directory is waarschijnlijk verkeerd voor deze branch. Controleer Output directory in Settings, en onthoud dat een branch de build output kan veranderen zonder de instelling te wijzigen. Zie Configuring Your Build Command and Output Directory.
De preview toont een ouder commit. Het pushen van een nieuw commit terwijl een build voor dezelfde branch nog steeds wordt uitgevoerd, annuleert de in-flight build en start een nieuwe. Als je een geannuleerde implementatie gevolgd door een lopende ziet, is dat normaal. Wacht op de tweede build.
De preview van een gesloten PR is nog steeds bereikbaar. Onderbreking gebeurt op de webhook-event. Als de provider-verbinding was verbroken toen je de PR sloot, is de event nooit aangekomen. Verwijder de preview handmatig via het Overview-tabblad.
Gerelateerde reading
- Deploying Your Project
- Setting Environment Variables Per Environment
- Orbit Plan Limits voor de omgevingstoelagen op elk plan