Sf Deploy

What it does

The Sf Deploy skill automates Salesforce deployments from Git repositories using the sf-deploy tool, streamlining your DevOps workflow. It orchestrates deployment processes including dry-run validation, targeted or manifest-based deploys, CI/CD guidance, scratch-org management, failure triage, and safe rollout sequencing for Salesforce metadata. This skill leverages the Salesforce CLI (v2) to manage deployments and retrieve information about your Salesforce orgs.

When to use it

• Automated Deployments: To execute deployment workflows as part of a CI/CD pipeline.
• Targeted Metadata Updates: When you need to deploy specific components like Apex, Flows, or permission sets.
• Deployment Validation: Before deploying changes to a Salesforce org, perform dry-run validations to identify potential issues.
• Release Sequencing: To manage the order of deployment for objects, permission sets, Apex, and Flows, preventing dependency failures.
• Troubleshooting Deployments: To assist in identifying and resolving deployment failure issues.

Key capabilities

• Supports sf project deploy start, quick, report, and retrieval workflows.
• Manages release sequencing across various Salesforce metadata types (objects, permission sets, Apex, Flows).
• Provides CI/CD gate integration and test-level selection for deployments.
• Generates deployment reports to track changes and identify potential issues.
• Handles failure triage and dependency ordering during deployments.
• Offers a default deployment order prioritizing metadata components (Custom objects/fields -> Permission sets -> Apex -> Flows as Draft -> Flow activation).

Example prompts

• "Can you perform a dry-run deployment of the force-app directory to my Salesforce org with alias <alias>?"
• "What is the recommended CI/CD workflow for deploying changes using a manifest file named manifest/package.xml?"
• "Deploy the permission sets in my Salesforce org."

Tips & gotchas

• Salesforce CLI Version: The skill requires Salesforce CLI version 2 (sf CLI v2).
• Explicit Scope Required: When deploying to non-source-tracking orgs, you must specify a deployment scope like --source-dir, --metadata, or --manifest.
• Dry-Run First: Always perform a dry-run (--dry-run) before executing actual deployments. For Flows, deploy safely and activate only after validation.