ナレッジベース

リポジトリからサイトをデプロイできるように、トークンを使用して GitHub アカウントを接続してください

デプロイするリポジトリ用のきめ細かな GitHub トークンを作成して接続すると、プッシュによってサイトがデプロイされ、ブランチでプレビューが表示されるようになります。

接続によるメリット

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

リポジトリが組織に属している場合は、代わりにZinn® GitHub アプリのご利用をおすすめします。詳細はZinn® GitHub アプリのインストールをご覧ください。トークンは1人の個人に帰属するため、そのユーザーが離脱すると動作しなくなります。

開始する前に

デプロイ対象のリポジトリへのアクセス権を持つ GitHub アカウントが必要です。それらのリポジトリが組織に属している場合、オーナーがその組織向けに Fine-grained トークンを承認しなければならない場合があります。

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 で表示されるのは一度だけです。

2. ここで接続する

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

保存が行われる前に、貼り付けられた内容がテストされます。動作しないキーは一切保存されず、応答メッセージで何が問題であったかが示されます。動作するキーはシークレット保管庫に暗号化されて保持され (当社のデータベースに保存されることはありません)、お客様ご自身に対しても二度と表示されません。

次に行われること

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

接続できない場合

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

動作していたものが停止した。 Fine-grained トークンは選択した日付で期限切れになります。新しいトークンを生成して接続してください。トークンの期限が切れる前に GitHub からメールが届きます。

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

接続はできるが、後で処理が失敗する。 キーの認証は通っていますが、そのアクションに必要な権限が不足しています。上記に記載された権限を持つ新しいキーを作成し、古い接続を切断した上で新しいキーを接続してください。

接続解除

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

接続を解除しても、すでに行われた処理が取り消されることはありません。お客様のアカウントで変更されたレコード、デプロイ、設定はそのまま残ります。キー自体が漏洩した可能性があると思われる場合は、ベンダー側でも無効化してください。接続解除によって削除されるのは当社のコピーであり、ベンダー側のコピーではありません。