Bewaar een onbeperkte geschiedenis van lay-outs op GitHub

De app bewaart de 25 meest recente versies van elke e-maillay-out. Koppel GitHub en elke versie wordt ook opgeslagen in een door u gekozen repository, zodat uw lay-outgeschiedenis onbeperkt is: bekijk wie wat heeft gewijzigd, herstel elke gewenste versie en bewaar een kopie van uw lay-outs buiten de app.

GitHub koppelen

1. Open in de app het menu ‘Ontwikkelaar’ en het tabblad ‘Verbindingen’.
2. Klik onder GitHub op ‘GitHub koppelen’. GitHub wordt in een nieuw tabblad geopend.
3. Installeer de app op uw GitHub-account of -organisatie en kies welke repositories de app mag gebruiken. Een privé-repository wordt aanbevolen. Indien u er nog geen hebt, maak deze dan eerst aan op github.com/new.
4. Ga terug naar de app, selecteer de repository onder ‘Repository’ en klik op ‘Deze repository gebruiken’.

De app slaat elke lay-out die u al hebt onmiddellijk op in de repository en voert vervolgens bij elke opslag een commit uit voor elke nieuwe versie.

Wat bevindt zich in de repository?

Eén bestand per lay-out in de map email-layouts, met als naam de id van de lay-out, bijvoorbeeld email-layouts/cmu3010yo01e4yn0wdjmh7xab.json. Dit bestand bevat de naam van de lay-out, het onderwerp, de voorbeeldtekst, de inhoud of het visuele ontwerp, en alle vertalingen. Elke keer dat er in de app wordt opgeslagen - via de API, door AI of door een herstelbewerking - vormt dit één commit met een bericht zoals Update "Order confirmation" (editor, v12).

Wanneer u een lay-out in de app verwijdert, wordt het bijbehorende bestand verwijderd; de eerdere commits blijven echter bewaard.

Een oudere versie herstellen

Open de lay-out en klik op Versiegeschiedenis. Onder de nieuwste versies die in de app zijn opgeslagen, geeft ‘Oudere versies op GitHub’ een overzicht van alle commits van de lay-out. Klik op ‘Bekijken’ om een voorbeeld van een versie te bekijken en op ‘Deze versie herstellen’ om deze weer in te zetten. Het herstel wordt opgeslagen als een nieuwe versie, zodat het ongedaan kan worden gemaakt.

Een lay-out bewerken in GitHub

Wijzig het lay-outbestand in de repository en voer een commit uit naar de gekoppelde branch: de app werkt de lay-out binnen enkele seconden bij. Het bestand wordt gecontroleerd zoals bij het opslaan in de app: Liquid moet geldig zijn, links en kleuren moeten veilig zijn en bestanden moeten naar uw winkel zijn geüpload. Een bestand dat de controle niet doorstaat, wordt genegeerd en de lay-out blijft ongewijzigd.

Een bestand kan geen nieuwe lay-out aanmaken, en het verwijderen van een bestand leidt niet tot het verwijderen van een lay-out; een onbedoelde commit zal dus nooit een e-mail verstoren die op dat moment wordt verzonden.

Verbinding verbreken

Ontwikkelaar > Verbindingen > GitHub > Verbinding met GitHub verbreken: hiermee wordt de verbinding verbroken en wordt de toegang van de app ingetrokken. De repository en de bijbehorende geschiedenis blijven in uw GitHub-account bewaard.

Via de API

GET /api/v1/email-templates/:id/versions/github geeft een overzicht van de versies op GitHub, en via POST /api/v1/email-templates/:id/versions/github/:sha/restore kunt u een versie terugzetten. De MCP-tools zijn te vinden op list_template_versions, samen met github: true en restore_template_github_version.