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

接続によって実現できること

GitLabを接続すると、GitLabリポジトリからのサイトのデプロイが可能になり、サイトのホストとして選択したアカウント上のGitLab Pagesへ公開できるようになります。

開始する前に

デプロイするプロジェクトへのアクセス権を持つGitLabアカウント。

1. GitLabでのキーの作成

GitLabで、右上のアカウントアバターを選択し、[プロファイルの編集] → [アクセス] → [個人アクセストークン]の順に移動して、新しいトークンを生成します（GitLabの[トークンの生成]メニューでは、これが[レガシートークン]と表示される場合があります）。名前を設定し、有効期限を設定し、次のスコープにチェックを入れます。

• api
• write_repository

[トークンの生成]を押してコピーします。GitLabでの表示は一度のみです。

2. ここでの接続

ダッシュボードで[連携]を開き、[アカウントの接続]を選択します。グループとして[コードホスティング]、アカウントとして[GitLab]を選び、[APIトークン]を入力して、[アカウントを接続]を押します。

保存される前に、貼り付けた内容がテストされます。機能しないキーが保存されることは決してなく、何が問題であったかがメッセージで示されます。機能するキーは、データベースではなく、シークレット用の保管庫に暗号化されて保管され、二度と（あなたに対しても）表示されることはありません。

その後の動作

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

接続できない場合

動作していたが停止した場合。 GitLabのトークンには必ず有効期限があります（通常は作成後最大1年以内）。GitLabから事前にメールで通知されます。新しいトークンを作成して接続してください。

スコープが不足している場合。 トークンのスコープは作成後に変更できません。両方のスコープにチェックを入れた新しいトークンを作成してください。

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

接続は成功するが、後続の処理で失敗する場合。 キーの認証は成功していますが、処理に必要な権限が不足しています。上記に挙げた権限を持つ新しいキーを作成し、古い接続を切断して新しいキーを接続してください。

接続の解除

[連携]を開き、該当するアカウントを見つけて[接続を解除]を押します。これにより、保存されているキーが即座に削除されます。キーを使用していたすべての機能は次のアクションで停止し、依存していた画面ではエラーがサイレントに無視されるのではなく、その旨が表示されます。

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