ナレッジベース

GitHub リポジトリとの双方向同期

サイトに加えた変更はご自身のリポジトリ内のコミットとなり、そこへプッシュした内容がサイトに反映されます。無料でご利用いただけます。両側で同時に変更が発生した場合の動作については、以下をご確認ください。

お客様ご自身の GitHub アカウントをサイトに連携していただければ、双方向で常に同期を保ちます。無料でご利用いただけ、お客様が有効にするまで無効のままです。また、弊社がコミットを行うのは常にお客様ご自身が所有するアカウントのリポジトリのみであり、弊社のリポジトリに対して行うことは決してありません。

同期される対象

ファイルマネージャー、SFTP、WordPress テーマエディター、SSH セッションなど、どのような方法であっても、サイトのファイルに加えられた変更はすべてリポジトリのコミットになります。お客様からご連絡いただく必要はありません。サイトと前回のコミットを比較し、その差分をプッシュいたします。

逆方向では、連携されたブランチへのプッシュがサイトへと反映されます。

決してコミットされない対象

お客様のwp-config.phpは、意図的かつ恒久的に除外されます。このファイルにはデータベースのパスワードや認証用ソルトが含まれており、これらはリポジトリに保存すべきではありません。git は履歴を永久に保持するため、プライベートリポジトリであっても同様です。

また、.envファイル、キーおよび証明書、アップロードフォルダー、キャッシュ、node_modulesも除外されます。リポジトリはサイトのソースコードを管理するものであり、バックアップではありません。メディアファイルはバックアップの管理対象であり、すでにそちらで保持されています。ここに含めてしまうと、プッシュのたびに時間がかかり、変更内容の確認も困難になります。

双方向で変更が発生した場合の挙動

こちらは特にご確認いただきたい点です。例えば、お客様がファイルマネージャーでファイルを編集している間に、同僚の方が同じリポジトリに変更をプッシュしたとします。

その場合、処理を一時停止します。マージを行うことも、誰かの変更を上書きすることもありません。サイトの Deploy タブに「Your repository has changes we haven't seen」と表示され、確認が必要なコミットが提示された上で、お客様の対応をお待ちします。待機中であっても双方のデータが失われることはありません。お客様の編集内容はサイト上に、同僚の方のコミットはリポジトリに保持されたままとなります。

その後、以下のいずれかをご選択いただきます。

このサイトのファイルを維持する — お客様のバージョンを相手のバージョンの上に適用します。相手のコミットは履歴に残り、何も消去されません。
リポジトリのバージョンを使用し、サイトの変更を破棄する — リポジトリのバージョンがサイトに適用され、サイト側で行った変更は破棄されます。この操作は元に戻せないため、慎重なクリックが必要であり、弊社が代行することは決してありません。

意図的に「自動マージ」オプションは設けておりません。弊社側でマージを行うと、双方が確認していない状態で、どちらも作成していないファイルが本番サイト上に生成されてしまうためです。

同期が停止する可能性のある原因

ご自身の GitHub アカウントが連携されていない場合。連携が完了するまでスイッチはオフのままとなります。
お客様の対応をお待ちしている状態の場合。上記のとおり、保留状態が自動的に解除されることはありません。
アカウントに未払いや利用制限がある場合。お支払いが正常に完了するまで同期は一時停止し、完了後に自動的に再開されます。データが失われることはありません。

Deploy タブには、変更がなかったものも含め、直近数回の同期履歴が表示されます。このリストが空で同期が有効になっている場合は、連携中のアカウントにリポジトリへの書き込み権限がない可能性が非常に高いため、アクセス権限をご確認のうえ再連携してください。

同期対象の選択

デフォルトではサイト全体が同期されます。WordPress サイトの場合、通常これは望ましい動作ではありません。お客様が記述したものではなく、編集することもない WordPress コアのすべてのファイルが含まれてしまうためです。「このフォルダーのみを同期」をお客様のテーマ (例: wp-content/themes/my-theme) に設定していただければ、それ以外の部分は変更されずに保持されます。