テンプレート
テンプレートは、再利用可能な Remote Dev Environment の設定です。マシンとそのセットアップを一度定義すれば、毎回同じ選択を繰り返すことなく、そこから一貫したセッションを作成できます。
テンプレートの概要Click to copy link
テンプレートには次の内容を含められます:
- スタック、マシンタイプ、ターミナルが開始する作業ディレクトリ。
- ライフサイクルフック:セッションの作成時、誰かがセッションを取得したとき、復元のたびに実行されるセットアップスクリプト。
- 環境に必要な値のための変数と入力。
- Workspaceリンク:IDEで特定のフォルダーを開くショートカットボタン。
- 仮想デバイス:テンプレートから作成されるすべてのセッションが起動する、iOSシミュレーターまたはAndroidエミュレーター。
ライフサイクルフックClick to copy link
テンプレートは、ライフサイクルフックでセッションをセットアップします。各フックは、セッションの存続期間中の特定のタイミングで、セッションユーザーとして実行されるBashスクリプトです:
- On create は、セッションの作成時に1回実行されます。リポジトリのクローンや依存関係のインストールなど、時間がかかる1回限りのセットアップに使用します。
- On claim は、セッションが誰かに割り当てられたときに実行されます。その人固有のセットアップに使用します。
- On restore は、停止したセッションが復元されるたびに実行されます。サービスの再起動に使用します。
すべてのフック は任意です。ライフサイクルフックの導入前に作成されたテンプレートには、代わりにウォームアップスクリプトと起動スクリプトがあります。これらは引き続き動作し、変換することもできます。
変数と入力Click to copy link
テンプレートには2種類の値があります:
- 変数はテンプレートに保存され、すべてのセッションで同じ値になります。変数をシークレットとしてマークすると保存時に暗号化され、保護対象としてマークすると書き込み専用にもなります。
- 入力はセッションごとに入力します。入力を必須にしたり、default valueを設定したりできます。入力は保存済み入力から値を取得することもでき、シークレットはサーバー上で解決され、UIには表示されません。
すべての変数と入力にはスコープがあります:Sharedの値はすべてのフックに届き、フック固有の値はそのフックにのみ届きます。値をセッションのターミナルでも使えるようにするには、Also in terminal をオンにします。変数と入力を参照してください。
WorkspaceリンクClick to copy link
Workspaceリンクは、セッション上のボタンで、指定したフォルダーパスを IDE で開きます。複数フォルダーのプロジェクトで、目的のディレクトリにすばやく移動するのに便利です。
宣言済みデバイスClick to copy link
テンプレートで仮想デバイスを宣言すると、そこから作成されるすべてのセッションで、セッション側のデバイス設定なしに iOS シミュレーターまたはAndroidエミュレーターが起動します。テンプレートフォームで Boot a device with every session をオンにするか、CLIを使用してください。
bitrise-cli rde template create --file template.json --device-platform ios --device-model "iPhone 16"
テンプレートのstack and machine typeは、プラットフォームに適合している必要があります。iOS の場合は macOS スタック、Androidの場合は Linux Android スタックです。テンプレートからセッションを作成するときは、デバイスを宣言どおりに維持するか、そ のセッションに限って個々のフィールドを変更するか、UIの Start an iOS simulator または Start an Android emulator、およびCLIの--no-deviceでオフにできます。テンプレートからすでに作成されたセッションは、作成時のデバイスを保持します。デバイスオプション自体については、Device sessionsで説明しています。
テンプレートの管理Click to copy link
Bitrise RDE UIから、またはCLIからbitrise-cli rde templateを使って、テンプレートの作成、編集、複製、削除ができます。
セッションを作成すると、そのテンプレート構成がスナップショットとして取得されます。その後にテンプレートを編集または削除しても、すでに作成されたセッションは変更されたり壊れたりしません。これはフックにも当てはまります:復元、失敗したフックの再実行、Rebuild はすべて、セッション作成時のスクリプトを使用します。修正したスクリプトを使うには、新しいセッションを作成してください。
Warm poolsClick to copy link
テンプレートのセッションを誰かが要求する前に準備しておくには、そこからwarm poolを作成します:テンプレートのページで Create warm pool をクリックすると、そのテンプレートが選択された状態でプールフォームが開きます。プールはテンプレートに従うため、テンプレートを編集するとプールのウォームセッションが置き換えられ、テンプレートを削除するとそのプールも削除されます。プールで適切に動作するテンプレートの書き方については、warm poolでのフックの使用を参照してください。