Przechowuj nieograniczoną historię układów na GitHubie

Aplikacja przechowuje 25 najnowszych wersji każdego szablonu wiadomości e-mail. Po połączeniu z serwisem GitHub każda wersja jest również zapisywana w wybranym przez Państwa repozytorium, dzięki czemu historia szablonów jest nieograniczona: mogą Państwo sprawdzić, kto wprowadził jakie zmiany, przywrócić dowolną wersję oraz przechowywać kopię swoich szablonów poza aplikacją.

Połącz z serwisem GitHub

1. W aplikacji proszę otworzyć sekcję Programista i zakładkę Połączenia.
2. W sekcji GitHub proszę kliknąć opcję Połącz z GitHubem. Strona GitHub otworzy się w nowej karcie.
3. Zainstaluj aplikację na swoim koncie lub w organizacji na GitHubie i wybierz repozytoria, z których może ona korzystać. Zaleca się użycie repozytorium prywatnego. Jeśli jeszcze go nie posiadasz, utwórz je najpierw pod adresem github.com/new.
4. Po powrocie do aplikacji wybierz repozytorium w sekcji Repozytorium i kliknij opcję Użyj tego repozytorium.

Aplikacja natychmiast zapisuje każdy posiadany już przez Państwa układ w repozytorium, a następnie zatwierdza każdą nową wersję w momencie zapisywania.

Co znajduje się w repozytorium

W folderze email-layouts znajduje się jeden plik na każdy układ, którego nazwa odpowiada identyfikatorowi układu, na przykład email-layouts/cmu3010yo01e4yn0wdjmh7xab.json. Zawiera on nazwę układu, temat, tekst podglądu, treść lub projekt graficzny oraz wszystkie tłumaczenia. Każde zapisanie w aplikacji, za pośrednictwem API, przez sztuczną inteligencję lub w wyniku przywrócenia stanowi jedno zatwierdzenie z komunikatem w rodzaju Update "Order confirmation" (editor, v12).

Usunięcie układu w aplikacji powoduje usunięcie jego pliku; wcześniejsze wersje zachowują jego historię.

Przywróć starszą wersję

Proszę otworzyć układ i kliknąć opcję Historia wersji. Poniżej najnowszych wersji przechowywanych w aplikacji, w sekcji Starsze wersje na GitHubie wyświetlona jest lista wszystkich commitów dotyczących tego układu. Proszę kliknąć Wyświetl, aby wyświetlić podgląd danej wersji, lub Przywróć tę wersję, aby ją przywrócić. Przywrócona wersja jest zapisywana jako nowa wersja, dzięki czemu można cofnąć tę operację.

Edytuj układ w serwisie GitHub

Wystarczy zmienić plik szablonu w repozytorium i zatwierdzić zmiany w podłączonej gałęzi: aplikacja zaktualizuje szablon w ciągu kilku sekund. Plik jest sprawdzany tak samo, jak podczas zapisywania w aplikacji: kod Liquid musi być poprawny, linki i kolory muszą być bezpieczne, a pliki muszą być przesłane do Państwa sklepu. Plik, który nie przejdzie tej kontroli, zostanie zignorowany, a szablon pozostanie bez zmian.

Plik nie może utworzyć nowego układu, a usunięcie pliku nie powoduje usunięcia układu, więc przypadkowe zatwierdzenie zmian nigdy nie zakłóca wysyłania wiadomości e-mail.

Odłącz

Programista > Połączenia > GitHub > Odłącz - ta opcja powoduje usunięcie połączenia oraz cofnięcie uprawnień aplikacji. Repozytorium i jego historia pozostają na Państwa koncie GitHub.

Za pośrednictwem interfejsu API

GET /api/v1/email-templates/:id/versions/github wyświetla listę wersji na GitHubie, a POST /api/v1/email-templates/:id/versions/github/:sha/restore przywraca jedną z nich. Narzędzia MCP to list_template_versions z parametrem github: true oraz restore_template_github_version.