メインコンテンツまでスキップ

Workflow Editorでのモジュール式構成の編集

設定がincludeキーワードを使って複数のYAMLファイルに分割されている場合でも、1つを変更するためにWorkflow Editorを離れる必要はありません。エディタはファイルツリー全体を読み込むため、マージ済みの設定を確認したり、個々のモジュールを編集したり、すべての変更を一度にリポジトリへプッシュしたりできます。

モジュラーエディタが利用可能になる条件

次の条件がすべて満たされると、Workflow Editorは自動的にモジュラー方式に切り替わります。

それ以外の場合、Workflow Editorは単一ファイル設定の場合とまったく同じように動作します。

includeキーワード、ネスト、マージルールについては、モジュラーYAML設定を参照してください。

マージ済み設定とモジュールビューClick to copy link​

モジュラーエディタでは、マージ済み設定用のタブが1つと、開いた各モジュール用のタブが追加されます。

Merged configタブには、すべてのモジュールが組み立てられ、すべてのプロパティが解決された設定全体、つまり実際に実行される設定が表示されます。あらゆる変更がそれを所有するファイルまで追跡できるように、このタブは仕様として読み取り専用になっています。ここからビルドを開始できます。

モジュールタブには1つのファイルが表示されます。編集可能なモジュール内では、そのファイルが参照するだけのエンティティは読み取り専用です。たとえば、別のモジュールで定義されたWorkflowがここに表示されますが、その定義を編集するには、それを所有するモジュール側で編集します。

対象表示内容編集ビルドの開始
マージ済み設定解決済みの設定全体読み取り専用可能
リポジトリ内のモジュールファイルが定義する内容と、他の場所で定義されたエンティティへの参照完全に編集可能不可
別のリポジトリ、ブランチ、タグ、またはコミットのモジュールファイルが定義する内容読み取り専用不可

編集が必要なモジュールを見つけるClick to copy link​

どのファイルが何を定義しているかを把握しておく必要はありません。Merged configから始めれば、エディタが教えてくれます。

  1. Workflow Editorを開き、Merged configタブのままにします。
  2. 変更したいWorkflow、Pipeline、またはその他のエンティティを見つけます。各カードには、それを定義しているモジュールが表示されます(例: Defined in .bitrise/workflows/deploy.yml)。
  3. エンティティを選択してEdit definitionをクリックします。エディタが、それを定義しているモジュールをそのエンティティが選択された状態で新しいタブで開きます。

Workflowが選択された状態のMerged configタブ。定義元のモジュールと「Edit 定義」アクションが表示されている

エンティティが複数のモジュールで定義されている場合、Edit definitionは、それらのモジュールをマージ順に一覧表示するため、必要なものを選択できます。

必要なファイルが既にわかっている場合は、直接開くこともできます。タブバーの+をクリックし、モジュールを開くポップオーバーでファイルを選択してください。このポップオーバーは、リポジトリのフォルダ構成をそのまま反映します。

設定のファイルツリーを表示する「モジュールを開く」ポップオーバー

モジュールを編集するClick to copy link​

モジュールの編集は、単一ファイル設定の編集と同じです。エディタの任意のページ、Workflows、Pipelines、Step bundles、環境変数、トリガー、コンテナ、Stacks & Machinesで、そのファイルが定義するものを作成、編集、削除、並べ替えできます。

編集可能なWorkflowを含む、独自のタブで開かれたモジュール

モジュラー設定に固有の点が2つあります。

  • アクティブなタブが、編集中のファイルです。タブを切り替えると、編集対象のファイルも切り替わります。未保存の変更がある間、タブにはドットが表示されます。
  • 別のモジュールで定義されたエンティティは、ここでは読み取り専用です。ただし、編集中のモジュールがそれらをどう使用するかは変更できます。たとえば、PipelineからWorkflowを削除することができます。定義そのものを変更するには、Edit definitionを使って、それを所有するモジュールを開いてください。

ピッカーは設定全体を対象に機能します。1つのモジュールで定義されたWorkflowを、別のモジュールから参照できます。

ビルドを開始するClick to copy link​

ビルドはMerged configタブから開始してください。単一のモジュールは、通常、設定の一部分にすぎません。別のファイルがStepsを追加したり、トリガーを変更したりする場合があります。モジュールから実行すると、表示されている内容とは異なるものが実行されるおそれがあります。

変更をプッシュするClick to copy link​

保存すると、変更したモジュールがまとめて1つのブランチにプッシュされます。GitHubおよびGitLabでは、保存は1回のコミットになります。Bitbucket Cloudでは、変更した各モジュールが個別にコミットされます。

  1. Save changesをクリックします。
  2. Push changesダイアログで、変更されたモジュールの一覧を確認します。各モジュールはフルパス付きで表示されます。
  3. Current branchを選択するか、New branchを選択して名前を付けます。
  4. コミットメッセージを入力します。
  5. Push changesをクリックします。

変更された3つのモジュールをフルパスとともに一覧表示するPush changesダイアログ

実際に変更したモジュールのみが書き込まれ、読み取り専用のモジュールが変更されることはありません。プッシュが成功すると、エディタは設定を再読み込みし、includeへの変更が反映されます。

編集中に他の誰かがプッシュしていて、変更したモジュールのいずれかがリポジトリ側でも変更されていた場合、プッシュ全体が拒否されます。どのモジュールも書き込まれないため、リポジトリが中途半端な状態のまま更新されることはありません。

リポジトリを手動で更新する

設定の変更を手動でコミットする場合は、プッシュダイアログでManual updateをクリックしてください。変更されたすべてのモジュールについて、ダウンロードとコピーのオプションが提供されるので、それらを自分でリポジトリにコミットします。

制限事項Click to copy link​

  • エディタからモジュールを追加または削除することはできません。includeの一覧は、YAMLモードで手動編集してください。次回の保存が成功すると、エディタが設定を再読み込みし、新しい構造が反映されます。
  • path、repository、branch、tag、commitといったincludeパラメータは編集できません。これらもYAMLモードで編集してください。
  • 別のリポジトリ、ブランチ、タグ、またはコミットのモジュールは編集できません。開いて読むことはできますが、変更はできません。

エディタが再読み込みされるまでは、includeの一覧を編集済みであっても、ファイルツリーとタブには前回読み込み時点の構造が表示されます。マージ済み設定には、編集内容が即座に反映されます。

モジュラー設定のトラブルシューティングClick to copy link​

Workflow Editorにモジュールが表示されないClick to copy link​

原因: モジュラーエディタが利用可能になる条件にある3つの条件をすべて満たしていません。

修正方法: 設定にincludeが1つ以上含まれていること、それがリポジトリに保存されていること、そしてWorkspaceがEnterpriseプランであることを確認してください。これら3つすべてを満たしているにもかかわらず単一ファイルエディタが表示される場合は、サポートチームにお問い合わせください。

編集したいフィールドがグレーアウトしているClick to copy link​

原因: 読み取り専用のMerged configタブを開いているか、そのエンティティを定義せずに参照しているだけのモジュールを開いています。

修正方法: エンティティをSelectし、Edit definitionをクリックして、それを定義しているモジュールを開きます。

includeの一覧を編集したのに、タブとファイルツリーが変わらないClick to copy link​

原因: エディタは設定を読み込む際にファイル構造を読み取るため、入力中に構造を再構成することはありません。

修正方法: 変更を保存してプッシュしてください。その後エディタが設定を再読み込みし、新しい構造が表示されます。

編集中のモジュールからビルドを開始できないClick to copy link​

原因: ビルドは常にマージ済み設定を実行するため、モジュールビューから開始することはできません。

修正方法: Merged configタブにSwitchし、そこでビルドを開始してください。