Mantenha um histórico ilimitado de layouts no GitHub

O aplicativo mantém as 25 versões mais recentes de cada layout de e-mail. Conecte-o ao GitHub e todas as versões também serão salvas em um repositório de sua escolha, de modo que seu histórico de layouts seja ilimitado: veja quem alterou o quê, restaure qualquer versão e mantenha uma cópia de seus layouts fora do aplicativo.

Conectar-se ao GitHub

  1. No aplicativo, abra a seção “Desenvolvedor” e a guia “Conexões”.
  2. Na seção “GitHub”, clique em “Conectar GitHub”. O GitHub será aberto em uma nova aba.
  3. Instale o aplicativo em sua conta ou organização do GitHub e escolha quais repositórios ele poderá utilizar. Recomenda-se o uso de um repositório privado. Caso ainda não tenha um, crie-o primeiro em github.com/new.
  4. De volta ao aplicativo, selecione o repositório na seção “Repositório” e clique em “Usar este repositório”.

O aplicativo grava imediatamente todos os layouts que você já possui no repositório e, em seguida, faz o commit de cada nova versão à medida que você salva.

O que há no repositório

Um arquivo por layout na pasta email-layouts, nomeado de acordo com o ID do layout, por exemplo, email-layouts/cmu3010yo01e4yn0wdjmh7xab.json. Ele contém o nome do layout, o assunto, o texto de pré-visualização, o conteúdo ou o design visual e todas as traduções. Cada salvamento no aplicativo, seja por meio da API, por IA ou por uma restauração, corresponde a um commit com uma mensagem como Update "Order confirmation" (editor, v12).

A exclusão de um layout no aplicativo exclui o arquivo correspondente; os commits anteriores mantêm seu histórico.

Restaurar uma versão anterior

Abra o layout e clique em “Histórico de versões”. Abaixo das versões mais recentes armazenadas no aplicativo, a seção “Versões anteriores no GitHub” lista todos os commits do layout. Clique em “Visualizar” para ver uma pré-visualização de uma versão e em “Restaurar esta versão” para revertê-la. A restauração é salva como uma nova versão, portanto, pode ser desfeita.

Editar um layout no GitHub

Altere o arquivo de um layout no repositório e faça o commit no branch conectado: o aplicativo atualiza o layout em questão de segundos. O arquivo é verificado da mesma forma que um salvamento no aplicativo: o código Liquid deve estar válido, os links e as cores devem estar corretos e os arquivos devem estar carregados na sua loja. Um arquivo que não passar na verificação é ignorado e o layout permanece como estava.

Um arquivo não pode criar um novo layout, e a exclusão de um arquivo não exclui um layout; portanto, um commit incorreto nunca prejudica um e-mail que esteja sendo enviado.

Desconectar

Desenvolvedor > Conexões > GitHub > Desconectar do GitHub remove a conexão e o acesso do aplicativo. O repositório e seu histórico permanecem na sua conta do GitHub.

Por meio da API

GET /api/v1/email-templates/:id/versions/github apresenta as versões no GitHub, e POST /api/v1/email-templates/:id/versions/github/:sha/restore permite restaurar uma delas. As ferramentas do MCP estão disponíveis em list_template_versions, juntamente com github: true e restore_template_github_version.