sf-deploy について
sf-deploy は、Salesforce のメタデータ展開を調整する開発者やリリースチーム向けのスキルです。事前検証、対象範囲の限定、依存関係に沿った順序、障害調査、展開後の確認を扱います。
主な機能
- 01展開前のドライラン検証
- 02ソース、マニフェスト、メタデータで範囲指定
- 03依存関係に沿ったリリース順序
- 04CI/CD とテストレベルの案内
- 05展開障害の調査と検証
活用シーン
- 01Salesforce の変更を展開前に検証
- 02オブジェクト、権限、Apex、Flow のリリース計画
- 03展開エラーの調査と結果確認
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ jaganpro/ sf-skills --skill sf-deployインストール後、Claude Code で/sf-deployを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
CREDITS.mdLICENSEREADME.mdassets/destructiveChanges.xmlpackage.xmlreferences/agent-deployment-guide.mddeploy.shdeployment-report-template.mddeployment-workflows.mdorchestration.mdtrigger-deployment-safety.md詳細
sf-deploy:包括的な Salesforce DevOps 自動化
ユーザーがデプロイのオーケストレーション(ドライラン検証、対象を絞ったデプロイまたはマニフェストベースのデプロイ、CI/CD ワークフローのアドバイス、スクラッチ組織の管理、失敗のトリアージ、Salesforce メタデータの安全なロールアウト手順)を必要とする場合に、このスキルを使用します。
このスキルが担当するタスク
以下の作業では sf-deploy を使用します。
sf project deploy start、quick、report、または取得ワークフロー- オブジェクト、権限セット、Apex、Flow にまたがるリリース手順
- CI/CD ゲート、テストレベルの選択、デプロイレポート
- デプロイ失敗のトラブルシューティングと依存関係の順序付け
以下の場合は、別のスキルに委任します。
- Apex または LWC コードの作成 → sf-apex、sf-lwc
- メタデータ定義の作成 → sf-metadata
- Flow の作成 → sf-flow
- 組織データの操作 → sf-data
- Agent Script ロジックの作成 → sf-ai-agentscript
重要な運用ルール
sfCLI v2 のみを使用します。- ソース追跡を行わない組織では、デプロイ/取得コマンドに
--source-dir、--metadata、--manifestなどの明示的な範囲指定が必要です。 - 実際にデプロイする前に、まず
--dry-runを実行することを推奨します。 - Flow は安全にデプロイし、検証後にのみ有効化します。
- テストデータ作成の案内は、メタデータの検証またはデプロイ後に
sf-dataへ委任します。
デフォルトのデプロイ順序
| フェーズ | メタデータ |
|---|---|
| 1 | カスタムオブジェクト/項目 |
| 2 | 権限セット |
| 3 | Apex |
| 4 | Draft としての Flow |
| 5 | Flow の有効化/デプロイ後の検証 |
この順序により、多くの依存関係や FLS の失敗を防げます。
先に収集する必須コンテキスト
次の情報を確認するか、推測します。
- 対象組織のエイリアスと環境の種類
- デプロイ範囲:source-dir、メタデータリスト、またはマニフェスト
- 検証のみ、デプロイ、クイックデプロイ、取得、CI/CD のどれについての案内か
- 必要なテストレベルとロールバックの想定
- 特殊なメタデータタイプ(Flow、権限セット、エージェント、パッケージ)が含まれるか
事前確認:
sf --version
sf org list
sf org display --target-org <alias> --json
test -f sfdx-project.json
推奨ワークフロー
1. 事前確認
認証、リポジトリの構成、パッケージディレクトリ、対象範囲を確認します。
2. まず検証
sf project deploy start --dry-run --source-dir force-app --target-org <alias> --wait 30 --json
変更セットの対象が絞られている場合は、マニフェストまたはメタデータの範囲を指定して検証します。
3. 検証に成功したら、次に安全なワークフローを提示
検証に成功した後、ユーザーを適切な次のアクションに案内します。
- 今すぐデプロイする
- 権限セットを割り当てる
- sf-data を使ってテストデータを作成する
- テスト/スモークチェックを実行する
- デプロイ後の複数の手順を順番にオーケストレーションする
4. 正しい範囲のうち、最小の範囲をデプロイ
# source-dir deploy
sf project deploy start --source-dir force-app --target-org <alias> --wait 30 --json
# manifest deploy
sf project deploy start --manifest manifest/package.xml --target-org <alias> --test-level RunLocalTests --wait 30 --json
# manifest deploy with Spring '26 relevant-test selection
sf project deploy start --manifest manifest/package.xml --target-org <alias> --test-level RunRelevantTests --wait 30 --json
# quick deploy after successful validation
sf project deploy quick --job-id <validation-job-id> --target-org <alias> --json
5. 検証
sf project deploy report --job-id <job-id> --target-org <alias> --json
続いて、テスト、Flow の状態、権限の割り当て、スモークテストの動作を確認します。
6. 明確に報告
デプロイされた内容、失敗した内容、スキップされた内容、次に取るべき安全なアクションをまとめます。
出力テンプレート:references/deployment-report-template.md
発生頻度の高い失敗パターン
| エラー/症状 | 考えられる原因 | デフォルトの修正方針 |
|---|---|---|
FIELD_CUSTOM_VALIDATION_EXCEPTION | 検証ルールまたは不正なテストデータ | データまたはルールの実行タイミングを調整する |
INVALID_CROSS_REFERENCE_KEY | 依存関係の不足 | 参照先のメタデータを先に含める |
CANNOT_INSERT_UPDATE_ACTIVATE_ENTITY | トリガー/Flow/検証による副作用 | 自動化の構成と失敗したロジックを調査する |
| デプロイ中にテストが失敗する | コードの不具合または脆弱なテスト | 対象を絞ったテストを実行し、根本原因を修正して再検証する |
| 権限セットで項目/オブジェクトが見つからない | 順序の誤り | 権限セットより先にオブジェクト/項目をデプロイする |
| Flow が無効/バージョンが競合する | 依存関係または有効化の問題 | Draft としてデプロイし、確認してから有効化する |
ワークフロー全体:references/orchestration.md、references/trigger-deployment-safety.md
CI/CD のガイダンス
デフォルトのパイプライン構成:
- 認証
- リポジトリ/組織の状態を検証
- 静的解析
- デプロイのドライラン
- テストとカバレッジのゲート
- デプロイ
- 検証と通知
- 組織のポリシーとリリースリスクが許容する場合は、Apex の比重が大きいデプロイで
--test-level RunRelevantTestsの使用を検討してください。 - これに、
sf-apexのドキュメントに記載されている@IsTest(testFor=...)や@IsTest(isCritical=true)などの最新の Apex テストアノテーションを組み合わせてください。
静的解析では、廃止された sf scanner ではなく、Code Analyzer v5(sf code-analyzer)を使用します。
詳細なリファレンス:references/deployment-workflows.md
Agentforce のデプロイに関する注意事項
エージェント周辺のデプロイ/公開の順序調整にはこのスキルを使用し、作成に関する判断にはエージェント固有のスキルを使用してください。
.agentの作成と検証には sf-ai-agentscript- Agent Builder/Prompt Builder/メタデータ設定には sf-ai-agentforce
Agent: 疑似メタデータ、公開/有効化、組織間の同期など、エージェントの DevOps に関する詳細は次を参照してください。
スキル間の連携
| 必要な作業 | 委任先 | 理由 |
|---|---|---|
| カスタムオブジェクト/項目の作成 | sf-metadata | デプロイ前にメタデータを定義する |
| Apex のコンパイル/レビュー/修正 | sf-apex | コードの作成と修正 |
| Flow の作成/修正 | sf-flow | Flow の作成と有効化に関するガイダンス |
| テストデータまたは初期レコード | sf-data | 説明を確認してからデータを設定、クリーンアップする |
| Agent Script のビルド/公開準備 | sf-ai-agentscript | エージェント固有の正確性 |
リファレンスマップ
まずはこちら
- references/orchestration.md
- references/deployment-workflows.md
- references/deployment-report-template.md
デプロイに関する専門的な安全対策
スコアガイド
| スコア | 意味 |
|---|---|
| 90+ | 優れたデプロイ計画と実行ガイダンス |
| 75–89 | 軽微なレビュー項目を除き、良好なデプロイガイダンス |
| 60–74 | デプロイリスクの一部をカバー |
| < 60 | 信頼性が不十分。ロールアウト前に計画を強化してください |
完了時の形式
Deployment goal: <validate / deploy / retrieve / pipeline>
Target org: <alias>
Scope: <source-dir / metadata / manifest>
Result: <passed / failed / partial>
Key findings: <errors, ordering, tests, skipped items>
Next step: <safe follow-up action>