Preview-implementaties geven elke pull request een eigen live URL, gebouwd vanuit de code van die branch, zodat reviewers door de daadwerkelijke wijziging kunnen klikken in plaats van een diff te lezen en te gokken. Elke preview wordt bijgewerkt wanneer u een nieuwe commit pusht en wordt automatisch opgeruimd zodra de pull request sluit.
Waar Preview-implementaties Zich Bevinden
Open Websites, klik op de site, open de groep Environment in het linkermenu van de site en kies Voorbeeld. De pagina heet Preview-implementaties.
Previews staan los van staging. Staging is één langlevende kopie van de site waar u doelbewust naartoe pusht; een preview is een kortlevende omgeving die per pull request wordt aangemaakt en daarna wordt weggegooid. Veel teams gebruiken beide. Zie Staging-omgevingen voor de andere helft.
Stel Eerst Git-implementatie In
Previews zijn geen op zichzelf staande functie. Ze hergebruiken de deploy-key en het buildcommando van de productiesite, dus de site heeft een werkende Git-implementatieconfiguratie nodig voordat previews kunnen worden ingeschakeld.
Als Git-implementatie niet is geconfigureerd, staat er op de pagina Stel eerst Git-implementatie in en wordt er een knop Ga naar Git-implementatie getoond in plaats van het inschakelformulier. Doorloop Een site implementeren vanuit Git en kom daarna terug.
Als Git-implementatie is gekoppeld maar geen buildcommando heeft, toont de Preview-pagina een waarschuwing. Previews gaan ervan uit dat de repository al gebouwd is, met statische bestanden in de hoofdmap. Dat klopt voor een eenvoudige HTML-site en is onjuist voor alles dat gecompileerd moet worden, dus stel een buildcommando in op de pagina Git-implementatie als uw project dat nodig heeft.
Previews Inschakelen
- Typ in de kaart Preview-implementaties inschakelen de repository in
owner/repo-vorm. Geen URL, geen SSH-adres: alleen de twee segmenten, bijvoorbeeldacme/marketing-site. - Klik op Inschakelen.
Alles wat niet overeenkomt met owner/name wordt afgewezen met Repo moet in eigenaar/naam-indeling zijn.
Direct na het inschakelen toont KPanel het ondertekeningsgeheim van de webhook in een kaart met de titel Kopieer uw webhook-secret nu, met een waarschuwing dat u het niet nogmaals te zien krijgt.
Kopieer het secret voordat u de pagina verlaat. Het wordt eenmalig gegenereerd en is daarna niet meer op te vragen. Als u het kwijtraakt, is de oplossing om het opnieuw te genereren, wat het oude ongeldig maakt en betekent dat u ook de webhook van uw repository moet bijwerken.
De Webhook Toevoegen Aan Uw Repository
De geconfigureerde kaart toont een Webhook-URL om te plakken in de instellingen van uw repository, onder Webhooks. Configureer deze met:
- Payload-URL: de webhook-URL die op de pagina wordt getoond.
- Secret: de waarde die u zojuist hebt gekopieerd.
- Type inhoud: JSON.
- Events: pull-request-events, plus pushes, zodat nieuwe commits op een open pull request de preview opnieuw opbouwen.
Zodra dat is ingesteld, bouwt het openen van een pull request binnen enkele minuten een preview. Een achtergrondtaak controleert elke minuut op nieuw previewwerk, dus u hoeft niets te doen in KPanel.
Preview-URL's
Elke preview krijgt een eigen hostnaam in de vorm pr-<pull-request-number>-<site-id>.kapsulecloud.app, gedekt door een wildcardcertificaat, zodat deze via HTTPS wordt geserveerd zonder dat u zelf een certificaatstap hoeft uit te voeren.
De betrouwbare manier om er een te openen is de knop Open op de rij van de preview in Recente previews, die de exacte URL bevat die voor die build is toegewezen. Plak die link in de pull request zodat reviewers KPanel helemaal niet hoeven te vinden.
De Lijst Met Recente Previews Lezen
De sectie Recente previews toont de meest recente previews, nieuwste eerst. Elke rij toont het pull-requestnummer en de titel, de branch, de commit en een status:
| Status | Betekenis |
|---|---|
| BUILDING | Wordt nu gekloond en gebouwd |
| LIVE | Wordt geserveerd op de preview-URL |
| FAILED | De build gaf een fout; klap het logboek uit om te zien waarom |
| DESTROYED | Opgeruimd, meestal omdat de pull request is gesloten |
Klik op Build-logboek omschakelen op een rij om de build-uitvoer inline uit te klappen. Dat logboek is de eerste plek om te kijken wanneer een preview mislukt, en het is dezelfde uitvoer die uw build lokaal zou produceren.
Als de lijst leeg is, meldt de pagina dat: open een pull request op de repository en er wordt binnen enkele minuten een preview gebouwd.
Het Webhook-Secret Roteren
Klik op Secret opnieuw genereren in de geconfigureerde kaart. KPanel vraagt om bevestiging en maakt expliciet duidelijk dat het huidige secret onmiddellijk stopt met werken en dat u het daarna in de webhookinstellingen van uw repository moet bijwerken.
Het nieuwe secret wordt eenmalig getoond, in dezelfde eenmalige kaart als voorheen. Kopieer het en werk vervolgens de webhook in uw repository bij. Tussen die twee momenten in worden inkomende webhookleveringen geweigerd, dus voer de twee stappen direct na elkaar uit.
Genereer het secret opnieuw wanneer iemand met beheerderstoegang tot de repository vertrekt, of als het secret ooit ergens is geplakt waar het niet had gemogen, zoals een gedeeld chatkanaal of een ticket.
Previews Uitschakelen
Klik op Uitschakelen. De configuratie wordt uitgezet en het opgeslagen secret wordt gewist. Bestaande previews worden niet meer opnieuw opgebouwd.
Ruim ook de webhook in uw repository op door deze te verwijderen. Deze zal dan beginnen met falen in plaats van iets schadelijks te doen, maar een webhook die voor altijd fouten retourneert is ruis in het leveringslogboek van uw repository.
Kosten En Onderhoud
Previews bouwen en serveren echte code, dus ze gebruiken dezelfde resources als elke andere implementatie op de site. Twee gewoontes houden dat onder controle:
- Sluit pull requests waar u niet meer aan werkt. Een gesloten pull request krijgt zijn preview automatisch opgeruimd.
- Richt previews niet op productiegegevens. Geef ze testsleutels via de omgeving preview van het tabblad Secrets, die juist daarom bestaat zodat preview- en productieconfiguratie niet door elkaar kunnen raken.
Een preview-URL is niet privé. Het is een echte, publiek bereikbare hostnaam met een geldig certificaat, en iedereen die de link heeft kan deze openen. Gebruik een preview niet om iets te beoordelen dat echte klantgegevens bevat, en vul preview-omgevingen niet met een productiedatabase-dump.
Probleemoplossing
Er wordt niets gebouwd wanneer een pull request wordt geopend. Controleer de recente leveringen van de webhook in uw repository. Een 401 of 403 betekent dat het secret niet overeenkomt, dus genereer het opnieuw en werk beide kanten bij. Geen enkele levering betekent dat de webhook niet is geabonneerd op pull-request-events.
De preview wordt gebouwd maar toont een mapoverzicht of een 404. De outputmap op de pagina Git-implementatie komt niet overeen met waar uw build daadwerkelijk naartoe schrijft. Previews erven die instelling van productie.
De build mislukt alleen in de preview. De meest voorkomende oorzaak is een afhankelijkheid of een omgevingsvariabele die wel in productie bestaat maar nooit aan de preview-omgeving is toegevoegd. Controleer het tabblad preview op de Secrets-pagina.
Een preview-URL stopt met werken. Bekijk de status op de bijbehorende rij. DESTROYED betekent dat de pull request is gesloten en de omgeving is teruggevorderd, wat het beoogde gedrag is.
Waar Verder Te Gaan
- Een site implementeren vanuit Git, de vereiste voorbereidende configuratie.
- App-secrets opslaan voor een site voor omgevingsspecifieke inloggegevens.
- Staging-omgevingen voor een permanente pre-productiekopie.