Skip to Content
ロリポップ!デプロイナウロリポップ!デプロイナウ
連携GitHub

GitHub 連携

ロリポップ!デプロイナウのプロジェクトには、GitHub のリポジトリを接続できます。 接続すると、指定したブランチに push するたびに自動でビルドとデプロイが始まり、成功すると公開中のサイトに反映されます。

GitHub へのアクセスを許可する

リポジトリの接続には GitHub App を使います。 初めて使うときは GitHub の画面へ移動し、GitHub アカウントの連携と、リポジトリへのアクセスを順に許可します。

GitHub アカウントを連携する

はじめに、GitHub アカウントをロリポップ!デプロイナウに連携します。

この認可は約 8 時間有効です。 期限が切れると、リポジトリ一覧の表示や新しい接続の作成前に、GitHub アカウントの再連携が必要になります。 GitHub App をインストールし直す必要はありません。 認可の期限が切れても、接続済みのリポジトリの自動デプロイは続きます。

GitHub アカウントへのアクセスを認可する画面

リポジトリへのアクセスを許可する

続いて、利用するリポジトリを所有する個人アカウントまたは Organization に GitHub App をインストールします。 インストール時に、ロリポップ!デプロイナウで利用するリポジトリを許可します。 GitHub App は、個人アカウントまたは Organization ごとにインストールします。 複数の所有者のリポジトリを使うときは、それぞれにインストールします。

GitHub でアクセスを許可するリポジトリを選ぶ画面

インストールすると、許可したリポジトリをロリポップ!デプロイナウの接続先として選べるようになります。 接続後、ロリポップ!デプロイナウは GitHub App を通じてソースコードを取得し、push の通知を受け取ります。

許可する範囲は、次のどちらかを選びます。

  • All repositories:現在あるリポジトリに加え、あとから作成したリポジトリも追加の許可なしで接続先として選べます。
  • Only select repositories:別のリポジトリを使うときは、GitHub 側で許可するリポジトリを追加します。

許可の範囲は、あとから GitHub 側で変更できます。

許可が終わると、プロジェクトごとに、許可したリポジトリから接続先とデプロイするブランチを選べます。

新しいプロジェクトを GitHub から作る

新しいプロジェクトを作成して GitHub のリポジトリを接続する手順は、GitHub からデプロイするを参照してください。

目的のリポジトリが一覧にないとき

一覧に出るのは、GitHub App にアクセスを許可したリポジトリだけです。 見つからないときは、次のどちらかで許可の範囲を広げます。

GitHub App をすでにインストールした個人アカウントまたは Organization のリポジトリなら、GitHub 側で対象のリポジトリを許可範囲に追加します。 別の個人アカウントまたは Organization のリポジトリなら、その個人アカウントまたは Organization に GitHub App をインストールし、対象のリポジトリを許可します。

GitHub 側で許可を変えたあとは、ロリポップ!デプロイナウでリポジトリ一覧を開き直すと反映されます。

既存のプロジェクトに接続する

すでにあるプロジェクトにもリポジトリを接続できます。 プロジェクト詳細画面の「設定」タブにある GitHub リポジトリの欄から、リポジトリとデプロイするブランチを選んで接続します。 接続すると、そのまま最初のデプロイが始まります。

接続できるリポジトリは 1 プロジェクトにつき 1 つです。

push による自動デプロイ

接続したブランチに push すると、新しいデプロイが自動で始まります。 それ以外のブランチへの push ではデプロイされません。 プルリクエストを作った時点ではデプロイされず、マージなどによって対象のブランチが更新されたときにデプロイされます。

デプロイの進み具合とビルドログは、プロジェクト詳細画面の「デプロイ」タブで確認できます。

接続したあとの設定を変える

「設定」タブの GitHub リポジトリの欄では、接続したあとに次の 3 つを変更できます。

リポジトリ、デプロイするブランチ、自動デプロイが並ぶ設定の欄

  • デプロイするブランチ:切り替えると、次の push から新しいブランチでデプロイされます。
  • 自動デプロイの停止と再開:停止すると、push してもデプロイが始まらなくなります。 公開中のサイトとリポジトリの接続はそのまま残ります。 再開すると、次の push から自動でデプロイされます。
  • 接続の解除:リポジトリとプロジェクトの接続を解除すると、以後の push ではデプロイが始まらなくなります。

接続を解除したあとに残るもの

接続を解除しても、これまでのデプロイ履歴と公開中のサイトは残ります。

GitHub App のインストールも GitHub 側に残ります。 ほかのプロジェクトにも接続していなければ、GitHub の設定からアンインストールしてください。 アンインストール後は、その個人アカウントまたは Organization が所有するリポジトリを新たに接続できません。 接続済みのリポジトリの自動デプロイも止まります。