ドキュメントメニュー
はじめに
ダッシュボードと分析
マネージドランナー
キャッシュ
チームと通知
請求とプラン
ヘルプ
GitHub App をインストールする
Latchkey の GitHub App のインストールの仕組み、なぜ組織アカウントが必要なのか、どの権限を使うのか、そして失敗したインストールの修正方法を説明します。
Latchkey は GitHub App を通じて GitHub に接続します。そのインストールは、他のすべてが依存する 1 回限りのセットアップステップです。webhook、分析、AI の推奨事項、マネージドランナーはすべてアプリを通じて流れます。そのため、何かが切断されているように見えるときに最初に確認すべきものでもあります。アプリが存在しない、または間違った組織に置かれている場合、下流のすべての機能が一度に症状を示します。
オンボーディング中にインストールする#
通常の道のりはオンボーディングのステップ 1 (「GitHub を接続」) です。Latchkey を承認 をクリックすると、GitHub が Latchkey アプリのインストールページを開きます。監視したい 組織 を選んで確認します。GitHub があなたを Latchkey に戻すと、インストールがワークスペースにリンクされ、オンボーディングはリポジトリ選択へと続きます。
組織アカウントが必須です#
Latchkey は GitHub の 組織 アカウントのみをサポートします。アプリが個人 (ユーザー) アカウントにインストールされた場合、Latchkey はそれを拒否します。インストールは GitHub から自動的にアンインストールされ、オンボーディングには「個人アカウントはサポートされていません」というエラーが表示されるので、組織で再試行できます。個人アカウントしかない場合は、まず GitHub の組織を作成 し (無料です)、リポジトリをそこへ移すか作成してください。
アプリがアクセスできるもの#
平たく言えば、Latchkey アプリは次のことを行います。
- ワークフロー実行とジョブのメタデータを読み取ります (名前、タイミング、ステータス、ランナーラベル)。これがコスト、パフォーマンス、信頼性のダッシュボードの元となる素材です。
.github/workflows/配下のワークフロー YAML ファイルを読み取ります。これにより AI がそれらを分析し、最適化 PR が編集するまさにそのファイルに対して具体的な変更を提案できます。- ワークフローイベントの webhook を受信します。これによりダッシュボードがリアルタイムで最新に保たれます。ポーリングや更新をするものが何もないのもこのためです。
- あなたが求めたときのみ、あなたに代わってプルリクエストを開きます。最適化の推奨事項の適用、または自己修復の修正提案の場合です。これらの PR は常にあなたのレビュー用で、自動的にマージされるものはなく、fork からのプルリクエストが触れられることは決してありません。
- 組織内で自身のランナーグループを管理します。これにより
runs-on: latchkey-*のジョブをマネージドランナーへルーティングできます。これはリポジトリの内容ではなく、組織の CI 配管です。
アプリが行わないこと: Latchkey はワークフローファイル以外のアプリケーションのソースコードを読み取らず、secret や環境変数の値を読むことも決してありません。セキュリティチームが、ランナーの隔離やデータ削除を含む全体像を求める場合は、セキュリティと GitHub の権限 を紹介してください。セキュリティレビューに直接答えられるように書かれています。
インストールがうまくいかない場合#
- 間違ったアカウントにインストールした場合: 個人アカウントだった場合、Latchkey はすでにインストールを削除しています。組織で再試行するだけです。間違った組織だった場合は、GitHub でその組織からアプリをアンインストールし (Settings、GitHub Apps)、正しい組織にインストールしてください。アプリが現在どこにあるかを確認するには、各組織の Settings、GitHub Apps ページを確認します。Latchkey はインストールされている場所ならどこでもリストに表示されます。
- インストール途中でタブを閉じた場合: もう一度サインインすると、Latchkey は中断したところからオンボーディングを再開します。先に元に戻す必要はありません。
- インストール権限がない場合: 組織に GitHub App をインストールするには owner または admin 権限が必要です。組織の owner にアプリのインストールを依頼するか、admin 権限を付与してもらい、オンボーディングから再試行してください。
よくある質問#
誰がワークスペースの owner になりますか？
GitHub App をインストールした人が、ワークスペースの owner としてリンクされます。ワークスペースごとに owner は 1 人だけで、owner は後で「所有権の移譲」でワークスペースを別のメンバーに引き渡せます。詳細は チームとロール にあります。
Latchkey を複数の組織にインストールできますか？
はい。各インストールは、独自のプラン、チーム、リポジトリ、データを持つ独自のワークスペースを得ます。ダッシュボードのサイドバーにあるワークスペース切り替えで、所属するワークスペース間を移動でき、Latchkey はサインインをまたいで最後に使用したワークスペースを記憶します。
インストールするには GitHub 組織の owner でなければなりませんか？
組織に対する owner または admin 権限が必要です。どちらもない場合は、組織の owner にアプリのインストールを依頼するか、admin 権限を付与してもらってください。
アプリをインストールするとリポジトリに何か変更が加わりますか？
いいえ。インストールするエージェントはなく、あなたが決めるまでワークフローへの変更もありません。Latchkey が書き込むのは、あなたがレビューできるプルリクエストを通じてのみです。あなたが適用する最適化、または自己修復の修正提案です。セキュリティと GitHub の権限 をご覧ください。