Mantenha um histórico ilimitado de layouts no GitHub

Mantenha um histórico ilimitado de layouts no GitHub

Copiar página

Ligue um repositório do GitHub para guardar todas as versões dos seus modelos de e-mail, restaurar qualquer uma delas e editar os modelos no GitHub.

A aplicação guarda as 25 versões mais recentes de cada modelo de e-mail. Ao ligar o GitHub, todas as versões são também guardadas num repositório à sua escolha, pelo que o seu histórico de modelos é ilimitado: veja quem alterou o quê, recupere qualquer versão e guarde uma cópia dos seus modelos fora da aplicação.

Ligar ao GitHub

  1. Na aplicação, abra a secção «Desenvolvedor» e o separador «Ligações».
  2. Na secção «GitHub», clique em «Ligar ao GitHub». O GitHub abre-se num novo separador.
  3. Instale a aplicação na sua conta ou organização do GitHub e selecione os repositórios que esta poderá utilizar. Recomenda-se a utilização de um repositório privado. Caso ainda não tenha um, crie-o primeiro em github.com/new.
  4. De volta à aplicação, selecione o repositório na secção «Repositório» e clique em «Utilizar este repositório».

A aplicação guarda imediatamente todos os layouts de que já dispõe no repositório e, em seguida, efetua o commit de cada nova versão à medida que vai guardando.

O que se encontra no repositório

Um ficheiro por layout na pasta email-layouts, cujo nome corresponde ao ID do layout, por exemplo, email-layouts/cmu3010yo01e4yn0wdjmh7xab.json. Este ficheiro 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 vez que se guarda na aplicação, através da API, por IA ou por uma restauração, é efetuado um commit com uma mensagem do tipo Update "Order confirmation" (editor, v12).

A eliminação de um layout na aplicação elimina o respetivo ficheiro; as versões anteriores mantêm o 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 guardadas na aplicação, a secção «Versões anteriores no GitHub» apresenta todos os commits do layout. Clique em «Ver» para pré-visualizar uma versão e em «Restaurar esta versão» para a repor. A restauração é guardada como uma nova versão, pelo que pode ser desfeita.

Editar um layout no GitHub

Altere um ficheiro de layout no repositório e submeta-o para o ramo ligado: a aplicação atualiza o layout em poucos segundos. O ficheiro é verificado tal como se fosse guardado na aplicação: o código Liquid deve ser válido, as ligações e as cores devem estar corretas e os ficheiros devem estar carregados na sua loja. Um ficheiro que não passe na verificação é ignorado e o layout permanece como estava.

Um ficheiro não pode criar um novo layout e a eliminação de um ficheiro não elimina um layout; por isso, um commit efetuado por engano nunca prejudica um e-mail que esteja a ser enviado.

Desligar

Desenvolvedor > Ligações > GitHub > Desligar o GitHub: esta ação remove a ligação e o acesso da aplicação. O repositório e o seu histórico permanecem na sua conta do GitHub.

Através 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 MCP estão disponíveis em list_template_versions, juntamente com github: true e restore_template_github_version.