GitHubリポジトリの接続

Before Orbit can deploy anything from GitHub you install the Kapsule Orbit GitHub App on your GitHub account or organisation and choose which repositories it can see. This guide walks through the…

Orbitを使用してGitHubからデプロイする前に、KapsuleのOrbit GitHub AppをGitHubアカウントまたはOrganisationにインストールし、どのリポジトリへのアクセスを許可するかを選択する必要があります。このガイドではインストール、リポジトリの選択、プロジェクトの作成、および期待していたリポジトリが表示されない場合の対処方法について説明します。

始める前に

GitHubアカウントまたはリポジトリを所有するOrganisationに対してGitHub Appをインストールする権限が必要です。個人アカウントの場合は自動的に権限があります。Organisationの場合は、オーナーであるか、またはオーナーがOrganisationの設定からインストールリクエストを承認する必要があります。

Step 1: Kapsule Orbit GitHub Appをインストールする

KPanelで左サイドバーのOrbitをクリックします。
New projectをクリックします。
モードをImport Git Repoのままにします。
ステップ1でConnect GitHubをクリックします。

GitHubに移動してKapsule Orbit Appをインストールします。GitHubはインストール先(個人アカウントまたはOrganisation)を尋ね、その後All repositoriesを付与するかOnly select repositoriesを付与するかを尋ねます。

Only select repositoriesを選択し、デプロイする予定のリポジトリのみにチェックを入れます。GitHubから後で追加することができ、Orbitで接続を切断または再作成する必要がなく、統合の影響範囲を小さく保つことができます。

完了すると、GitHubはKPanelに戻します。ステップ1にJust connectedと表示され、ステップ2にリポジトリが読み込まれます。

Step 2: リポジトリを選択する

アクセス可能なリポジトリがリストとして表示されます。デプロイするリポジトリのSelectをクリックします。プライベートリポジトリはPrivateバッジを表示します。Orbitはパブリックリポジトリとプライベートリポジトリの両方をデプロイできます。

選択されると、リポジトリにSelectedバッジが表示され、Changeリンクで別のリポジトリを選択できます。

リポジトリが見つからない場合

Orbitはアクセス可能なリポジトリのみをリストアップできます。期待していたリポジトリが表示されない場合:

ステップ1のReconnect GitHubをクリックしてインストールフローを再実行するか、github.com/settings/installationsを直接開きます。
Kapsule Orbitインストールを開き、Repository accessの下に見つからないリポジトリを追加します。
KPanelに戻ります。リストが更新されます。

パネルにNo repos accessibleと表示されている場合、Appはインストールされていますが、リポジトリへのアクセス権がまったく付与されていません。GitHub Appの設定を開き、少なくとも1つのリポジトリへのアクセスを付与します。

その他の一般的な原因:

リポジトリが、AppをインストールしていないOrganisationに属している。個人アカウントにインストールすると、Organisation のリポジトリはカバーされません。
Organisation のオーナーがインストールリクエストをまだ承認していない。承認されるまで、Appは存在しますが何も表示されません。
リポジトリが転送または名前変更された後、Appをインストールした。インストールフローを再実行して、Orbitが表示できる内容を更新します。

Step 3: プロジェクトを設定する

リポジトリが選択されると、ステップ3では2つのフィールドを入力する必要があります:

フィールド	説明
Project Name	KPanelの表示名。例: `my-app`
Deploy URL	`kaps.run`の下のサブドメイン。`my-app`は`my-app.kaps.run`になります

Create projectをクリックします。Orbitはリポジトリをクローンし、最初のビルドをキューに入れ、ログストリームを監視できるプロジェクト概要ページに移動します。

Deploy URLスラッグは作成時に設定され、その後は変更できません。後で別のパブリックアドレスが必要な場合は、スラッグの名前変更を試みるのではなく、カスタムドメインをアタッチしてください。Adding a Custom Domain to Your Projectを参照してください。

Orbitが自動的にセットアップするもの

プロジェクトを作成すると、プッシュツーデプロイが自動的に接続されます。手動で設定するウェブフックはありません:

本番ブランチへのプッシュは本番デプロイをキューに入れます。
Branch previewsが有効な場合、他のブランチへのプッシュはbranch-<branch-name>.kaps.runで分離されたプレビューをビルドします。Branch Preview Deployments in Orbitを参照してください。
プルリクエストのアクティビティが追跡されるため、プレビューデプロイは属するPR番号を表示します。
プルリクエストを閉じるまたはマージすると、そのプレビューが一時停止され、ストレージは約1日以内に解放されます。

GitHub Actionsのデプロイをゲートする

GitHub Actionsでテストを実行する場合、Orbitがそれを待つようにすることができます。SettingsでCI required checksに、コンマで区切った正確なActions ジョブ名を入力します。例: build,test,lint。すべての指定チェックがパスする必要があり、その後でプッシュトリガー本番デプロイが進行します。CIが失敗した場合、Orbitのデプロイは自動的にキャンセルされます。

これは本番ブランチにのみ適用されます。

インストールを再接続または変更する

Orbitが表示可能なリポジトリを変更するには:

Orbitをクリックし、New projectをクリックします。
ステップ1でReconnectをクリックしてGitHub Appのインストールフローを再実行します。

またはgithub.com/settings/installationsでインストールを直接管理します。そこで行った変更は、次回Orbitがリポジトリをリストアップするときに反映されます。

GitHubの接続を切断する

New projectのステップ1でDisconnectをクリックします。

接続を切断すると、Kapsuleアカウントとgithub間のリンクが削除されます。プロジェクトとそのデプロイ履歴は保持され、現在ライブのデプロイはトラフィック提供を継続しますが、再接続するまでプッシュトリガーデプロイは停止します。デプロイフックはプロバイダー接続を通じてブランチの先頭をフェッチするため、引き続き機能します。接続が切断されている場合、フック呼び出しはエラーで失敗し、古いコードをデプロイするのではなく失敗します。