deploying-ui-bundle

UI バンドルのデプロイ

Salesforce 組織にデプロイする際は、操作の順序が非常に重要です。この順序は標準的なフローを示しています。

ステップ 1：組織の認証

組織が接続されているか確認します。接続されていない場合は、認証します。以降のすべてのステップで、認証済みの組織が必要です。

ステップ 2：デプロイ前の UI バンドルのビルド

依存関係をインストールし、UI バンドルをビルドして dist/ を生成します。UI バンドルのエンティティをデプロイする前に必要です。

実行するタイミング：UI バンドルをデプロイする場合で、dist/ が存在しないか、ソースが変更されているとき。

ステップ 3：メタデータのデプロイ

まずマニフェスト（manifest/package.xml または package.xml）があるか確認します。存在する場合は、マニフェストを使用してデプロイします。存在しない場合は、プロジェクト内のすべてのメタデータをデプロイします。

オブジェクト、レイアウト、権限セット、Apex クラス、UI バンドル、およびその他すべてのメタデータをデプロイします。スキーマの取得前に完了する必要があります。スキーマには組織の状態が反映されるためです。

ステップ 4：デプロイ後の設定

デプロイしただけでは割り当てられません。デプロイ後に、次の操作を行います。

• 権限セット／グループ — ユーザーがカスタムオブジェクトや項目にアクセスできるよう、ユーザーに割り当てます。GraphQL のイントロスペクションで正しいスキーマを返すために必要です。
• プロファイル — ユーザーに適切なプロファイルが設定されていることを確認します。
• その他の設定 — 名前付き認証情報、接続アプリ、カスタム設定、フローの有効化。

先回りして行う操作：デプロイが成功した後、force-app/main/default/permissionsets/ 内の権限セットを検出し、それぞれを割り当てます（またはユーザーに確認します）。

ステップ 5：データのインポート（任意）

data/data-plan.json が存在する場合にのみ行います。削除はプランの順序を逆にして実行します（子を先に、親を後に削除）。インポートでは、重複ルールの保存を有効にした Anonymous Apex を使用します。

データをインポートまたはクリーンアップする前に、必ずユーザーに確認してください。

ステップ 6：GraphQL スキーマとコード生成

1. デフォルトの組織を設定する
2. スキーマを取得する（GraphQL イントロスペクション）— プロジェクトのルートに schema.graphql を書き込みます
3. 型を生成する（codegen はローカルのスキーマを読み込みます）

実行するタイミング：スキーマが存在しない場合、または前回の取得以降にメタデータ／権限が変更された場合。

ステップ 7：最終的な UI バンドルのビルド

ステップ 2 でまだビルドしていない場合は、UI バンドルをビルドします。

まとめ：操作の順序

1. 組織を確認／認証する
2. UI バンドルをビルドする（UI バンドルをデプロイする場合）
3. メタデータをデプロイする
4. 権限を割り当てて設定する
5. データをインポートする（データプランがある場合は、ユーザーに確認する）
6. GraphQL スキーマを取得して codegen を実行する
7. UI バンドルをビルドする（必要な場合）

重要なルール

• スキーマを取得する前にメタデータをデプロイします — カスタムオブジェクト／項目はデプロイ後にのみ表示されます
• スキーマを取得する前に権限を割り当てます — ユーザーにはカスタム項目の FLS がない場合があります
• オブジェクト、項目、または権限を変更するメタデータのデプロイを行うたびに、スキーマの取得と codegen を再実行します
• 権限セットの割り当てやデータのインポートを黙って省略しないでください — 実行するか、ユーザーに確認してください

デプロイ後のチェックリスト

メタデータのデプロイが成功するたびに、次の操作を行います。

1. 権限セットを検出して割り当てる（またはユーザーに確認する）
2. data/data-plan.json が存在する場合は、データのインポートについてユーザーに確認する
3. UI バンドルのディレクトリからスキーマの取得と codegen を再実行する