Bitbucket リポジトリへの接続

Bitbucket connects to Orbit through OAuth: you authorise Kapsule once, Orbit lists the repositories your Bitbucket account can reach, and it registers a webhook per repository so every push triggers…

Bitbucket は OAuth を通じて Orbit に接続します。Kapsule を一度認可すると、Orbit は Bitbucket アカウントがアクセスできるリポジトリを一覧表示し、リポジトリごとに webhook を登録して、すべてのプッシュがビルドをトリガーします。このガイドでは、接続、リポジトリの選択、プロジェクトの作成、およびリポジトリが表示されない場合の確認内容について説明します。

開始する前に

Orbit が見えるのは、Bitbucket アカウントが見えるもののみです。ワークスペースリポジトリの場合は、少なくとも書き込みアクセス権が必要であり、リポジトリ webhook を作成するための十分な権限が必要です。ワークスペースがサードパーティ OAuth コンシューマーを制限している場合は、接続が成功する前に管理者が Kapsule Orbit を許可する必要があります。

ステップ 1: Bitbucket を接続する

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

Kapsule Orbit OAuth コンシューマーを認可するために Bitbucket に送信されます。要求された権限を付与すると、Bitbucket はリポジトリが読み込まれた状態で KPanel に戻します。ステップ 1 に Just connected と表示されます。

認可に失敗した場合、KPanel は Bitbucket が返したエラーを表示します。むやみに再試行するのではなく、読み取ってください。ワークスペースポリシーブロックとキャンセルされた認可は似ていますが、異なる修正が必要です。

ステップ 2: リポジトリを選択する

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

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

リポジトリのアクセスレベルを確認します。読み取りアクセスでは不十分です。Orbit が必要な webhook を登録するには、write アクセス権が必要です。
リポジトリがリンクのみを持つワークスペースではなく、実際に所属しているワークスペース内にあることを確認します。
ステップ 1 で Reconnect Bitbucket をクリックして、OAuth フローを再実行し、トークンとリポジトリリストを更新します。

パネルに No repos accessible と表示される場合、grant は成功しましたが何も返されませんでした。再接続して、リポジトリスコープを承認したことを確認します。

ステップ 3: プロジェクトを構成する

フィールド	機能
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 はプロジェクト作成時に Bitbucket リポジトリに webhook を登録します。その後:

本番ブランチへのプッシュは本番デプロイをキューに入れます。
他のブランチへのプッシュは、Settings の Runtime で Branch previews が有効な場合、branch-<branch-name>.kaps.run で分離されたプレビューをビルドします。Branch Preview Deployments in Orbit を参照してください。
ブランチを削除すると、そのプレビュー環境が一時停止され、ストレージは約 1 日以内に回収されます。

webhook を自分で作成または保守することはありません。

Orbit の CI required checks 設定は、GitHub Actions ジョブ名または GitLab パイプラインでのデプロイをゲートします。Bitbucket Pipelines ではゲートされません。デプロイが発生するタイミングを Bitbucket Pipelines が決定する必要がある場合は、そのブランチのプッシュトリガーデプロイを無効にし、成功時にパイプラインがデプロイフックを呼び出すようにしてください。Triggering Deployments Via Deploy Hooks を参照してください。

Bitbucket を再接続または切断する

Orbit をクリックしてから、New project をクリックします。
ステップ 1 で、Reconnect をクリックして OAuth フローを再実行するか、Disconnect をクリックしてリンクを削除します。

リポジトリリストが機能しなくなったときは常に再接続が正しい最初のステップです。OAuth トークンは期限切れになり、再接続すると新しいトークンが生成されるためです。

切断するとプロジェクトとそのデプロイ履歴が保持され、ライブデプロイはトラフィックの提供を続けます。プッシュトリガーデプロイが停止します。デプロイフックも停止します。フックは、デプロイするもの決定するためにプロバイダー接続を通じてブランチヘッドを読み取るためです。