Quickstart: ゼロからダッシュボードまで

GitHub でサインイン

latchkey.dev/sign-in にアクセスし、GitHub アカウントでサインインします。監視したい組織にアクセスできる GitHub アカウントを使用してください。次のステップのアプリのインストールはこのアイデンティティで行われ、アプリをインストールした人がワークスペースの owner になります。サインインするとダッシュボードの Get started カード (「Welcome to Latchkey」) に到着し、30 日間トライアルはすでに開始されています。クレジットカードは不要です。途中で中断された場合は、もう一度サインインするだけで、セットアップは中断したところから再開します。

GitHub を接続

Get started カードのステップ 1 は Connect GitHub です。クリックすると、Latchkey はアプリをインストールするために GitHub へ移動させます (その前に、何が起こるかを説明する短い中間画面が表示されます)。GitHub がインストール先を尋ねたら、組織 を選択してください (個人アカウントで実行できるのは Latchkey CI のみです)。組織に対する owner または admin 権限が必要です。どちらもない場合は、組織の owner にアプリのインストールを依頼するか、admin 権限を付与してもらってください。アプリがアクセスできるものとできないものについては GitHub App をインストールする で説明しています。

監視するリポジトリを選択

Get started カードのステップ 2 Select repositories はリポジトリピッカーを開きます。ここには検索と可視性フィルターとともに組織のリポジトリが一覧表示されます。Latchkey に監視させたいものを選択してください。カウンターにはプランで許可される数が表示されます (すべての新規ワークスペースが開始する Launch は 10。後でプランを変更した場合、Developer は 1、Scale は 40)。選ぶ際に知っておくとよいことが 2 つあります。マネージドランナーは監視対象のリポジトリのみを扱うため、latchkey-* ラベルを向ける予定のリポジトリは含めてください。また、「Skip for now, explore the dashboard first」リンクでこの選択を後回しにし、後でダッシュボードからリポジトリを追加することもできます。プラン上限内で選ぶ際のガイダンスは リポジトリの管理 にあります。

ダッシュボードが埋まるのを見る

セットアップ後、ダッシュボードのガイド付きツアーが提示されます。どのステップでも終了でき、Account and help メニューからもう一度開けます。有効にした各リポジトリについて、Latchkey は直近 30 日間の完了済みワークフロー実行をバックフィルするため、ほとんどのチームは数分でデータを確認できます。バックフィルの実行中は進捗バナーが表示されます。ページが空に見える場合、表示内容を決めているのは Command & Control の Filters と Date range のウィンドウです。

任意: Latchkey ランナーでジョブを実行

任意のワークフローの 1 行を変更して、マネージドな自己修復ランナーを試します。push すると、ランナーがピックアップするまでジョブは GitHub 上でキュー待機と表示されます。ウォームなランナーが既にオンラインの場合は約 2 秒、新しいランナーがコールドスタートする場合はそれより長くかかります。ジョブがどこで実行されたかを確認する方法を含む完全な手順は 最初のジョブを実行する にあります。

jobs:
  build:
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v4
      - run: npm ci && npm test

任意: チームを招待

Developer を除くすべてのプランでは、ダッシュボードのサイドバーで Team を開き、メールまたは共有リンクでチームメイトを招待します (Developer プランは個人利用向けのため、そこでは招待は利用できません)。招待では Admin または Member ロールが付与されます。チームとロール をご覧ください。