GitHubでレイアウトの履歴を無制限に保存する

このアプリでは、すべてのメールレイアウトの最新25バージョンを保存します。GitHubと連携させると、各バージョンが指定したリポジトリにも保存されるため、レイアウトの履歴は無制限に保存されます。誰が何を変更したかを確認したり、任意のバージョンを復元したり、アプリ外にレイアウトのコピーを保存したりすることができます。

GitHub を連携する

アプリで、「Developer」を開き、「Connections」タブを選択してください。
「GitHub」の下にある「GitHub を接続」をクリックしてください。GitHub が新しいタブで開きます。
GitHubのアカウントまたは組織にアプリをインストールし、アプリが使用できるリポジトリを選択してください。プライベートリポジトリの使用をお勧めします。まだお持ちでない場合は、まず github.com/new で作成してください。
アプリに戻り、「**リポジトリ」**の下にあるリポジトリを選択し、「**このリポジトリを使用」**をクリックしてください。

このアプリは、既存のレイアウトをすべてすぐにリポジトリに書き出し、保存するたびに新しいバージョンをコミットします。

リポジトリには何が含まれていますか

email-layoutsフォルダ内には、レイアウトごとに1つのファイルがあり、そのファイル名はレイアウトのIDに基づいて命名されています。例えば、email-layouts/cmu3010yo01e4yn0wdjmh7xab.jsonといった形です。このファイルには、レイアウト名、件名、プレビューテキスト、コンテンツまたはビジュアルデザイン、およびすべての翻訳が含まれています。アプリ内での保存、API経由での保存、AIによる保存、または復元が行われるたびに、Update "Order confirmation" (editor, v12)といったメッセージ付きのコミットが1つ生成されます。

アプリ内でレイアウトを削除すると、そのファイルも削除されますが、以前のコミットは履歴として残ります。

以前のバージョンを復元する

レイアウトを開き、**「バージョン履歴」をクリックしてください。アプリ内に保存されている最新バージョンの下にある「GitHub上の古いバージョン」には、そのレイアウトのすべてのコミットが一覧表示されます。「表示」をクリックするとプレビューを確認でき、「このバージョンを復元」**をクリックするとそのバージョンに戻すことができます。復元操作は新しいバージョンとして保存されるため、元に戻すことも可能です。

GitHubでレイアウトを編集する

リポジトリ内のレイアウトファイルを変更し、接続されたブランチにコミットすると、アプリは数秒以内にレイアウトを更新します。ファイルのチェックは、アプリ内での保存時と同様に行われます。Liquidが有効であること、リンクや色が安全であること、そしてファイルがストアにアップロードされていることが必要です。チェックに失敗したファイルは無視され、レイアウトは変更されません。

ファイルでは新しいレイアウトを作成することはできませんし、ファイルを削除してもレイアウトは削除されないため、誤ってコミットしても、送信中のメールが破損することはありません。

切断

**「開発者」 > 「接続」 > 「GitHub」 > 「GitHubの接続を解除」を選択すると、**接続が解除され、アプリのアクセス権も取り消されます。リポジトリとその履歴は、引き続きGitHubアカウントに残ります。

APIを通じて

GET /api/v1/email-templates/:id/versions/github GitHubには各バージョンが一覧表示されており、POST /api/v1/email-templates/:id/versions/github/:sha/restore を実行すると、そのバージョンを復元できます。MCPツールは、list_template_versions、github: true、およびrestore_template_github_version です。