GitHub アカウントをトークンで連携して、リポジトリからサイトをデプロイできるようにします

接続により実現できること

GitHubをトークンで接続すると、リポジトリの1つからサイトをデプロイできるようになります。ブランチにプッシュするだけでサイトが更新されます。また、サイトのホストとして選択した場合には、お客さまのアカウントの GitHub Pages に公開することもできます。

リポジトリが組織に属している場合は、代わりに Zinn® GitHub アプリ の使用をお勧めします（Zinn® GitHub アプリのインストール をご覧ください）。トークンは1人の個人に帰属し、その人物が退職すると機能しなくなります。

開始する前に

デプロイしたいリポジトリへのアクセス権を持つ GitHub アカウントが必要です。それらのリポジトリが組織に属している場合、組織の所有者がきめ細かなアクセストークン（fine-grained token）を承認する必要がある場合があります。

1. GitHub でキーを作成する

GitHub でプロフィール画像をクリックし、Settings → Developer settings → Personal access tokens → Fine-grained tokens → Generate new token の順に選択します。名前を付け、有効期限を選択します。Repository access で Only select repositories を選択し、デプロイするリポジトリ（動作する最小限のアクセス範囲）を選びます。

Repository permissions で、以下に対して Read and write の権限を付与します。

• Contents
• Pages
• Administration

Generate token を押してコピーします。GitHub で表示されるのは1回のみです。

2. ここで接続する

ダッシュボードで Integrations を開き、Connect an account を選択します。グループとして Code hosting、アカウントとして GitHub を選択し、API token を入力して、Connect account を押します。

保存される前に、入力された内容のテストが実行されます。機能しないキーは保存されず、何が問題であったかがメッセージとして表示されます。機能するキーは、データベース内ではなく、当社のシークレット保管庫に暗号化されて保管され、お客さまご自身を含め、二度と再表示されることはありません。

その後の動作

• このアカウント上のリポジトリから直接サイトをデプロイできます。サイトのリポジトリ接続でそのリポジトリを選択し、リポジトリとブランチを選ぶことで、プッシュによりデプロイが行われます。
• 他のすべてのブランチで独自のプレビューを取得できるため、ライブサイトに反映される前に変更内容を確認できます。
• Render や Azure Static Web Apps などの Git ビルド型静的ホストは、この接続をサイトのコードのソースとして使用します。

接続できない場合

リポジトリが表示されない。 トークンのリポジトリアクセスにそのリポジトリが含まれていません。GitHub でトークンを編集し、リポジトリを追加してください。

動作していたが停止した。 きめ細かなアクセストークンは、選択した日付で有効期限が切れます。新しいトークンを生成して接続してください。有効期限が切れる前に GitHub からメールが届きます。

キーが拒否されたと表示される。 ほとんどの場合、次の3つのいずれかが原因です：スペースや改行が一緒にコピーされた、有効期限が切れたキーである、またはコピーした後にキーが取り消された（レボークされた）か再生成された。新しいキーを作成して、再度貼り付けてください。

接続は成功するが、その後の処理で失敗する。 キーの認証は成功しますが、処理に必要な権限が不足しています。上記に記載されている権限を持つ新しいキーを作成し、古い接続を解除してから新しいキーを接続してください。

接続の解除

Integrations を開き、該当するアカウントを見つけて Disconnect を押します。これにより、保存されているキーが即座に削除されます。そのキーを使用していたすべての処理は次回の実行時に停止し、静かに失敗するのではなく、それに依存していた画面にその旨が表示されます。

接続を解除しても、すでに実行された内容（記録、デプロイ、またはお客さまのアカウント上で変更された設定）は元に戻りません。キー自体が漏洩した可能性があると思われる場合は、ベンダー側でもキーを取り消してください。接続を解除することで削除されるのは当社のコピーであり、ベンダー側のコピーではありません。