ナレッジベース

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

api および write_repository スコープを持つ GitLab パーソナルアクセストークンを作成して接続すると、プッシュによってサイトがデプロイされます。

連携によるメリット

GitLab を連携すると、お客様の GitLab リポジトリからサイトをデプロイできるようになり、サイトのホストとして選択された場合には、お客様のアカウントの GitLab Pages へ公開できるようになります。

開始する前に

デプロイ対象のプロジェクトへのアクセス権を持つ GitLab アカウントをご用意ください。

1. GitLab でキーを作成する

GitLab で右上のアバターを選択し、Edit profile → Access → Personal access tokens の順に進み、新しいトークンを生成します (GitLab の Generate token メニューでは Legacy token と表示される場合があります)。名前を付け、有効期限を設定し、以下のスコープにチェックを入れます:

api
write_repository

Generate token を押し、コピーしてください。GitLab で表示されるのは一度だけです。

2. こちらで連携する

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

保存処理が行われる前に、貼り付けられた内容がテストされます。機能しないキーが保存されることは決してなく、エラーの原因が表示されます。機能するキーは、データベースではなく当社のシークレット保管庫に暗号化されて保管され、お客様に対しても二度と再表示されることはありません。

次に行われること

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

接続できない場合

以前は機能していたのに停止した場合。 GitLab トークンには必ず有効期限があり (通常は作成後最長1年)、期限が切れる前に GitLab からメールが届きます。新しいトークンを作成して連携してください。

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

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

接続は完了したものの、その後の処理が失敗する場合。 キーの認証には成功したものの、実行しようとするアクションに必要な権限が不足しています。上記の権限を持つ新しいキーを作成し、古い接続を解除してから新しいキーを連携してください。

連携の解除

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

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