PluginBench
Skill
Fail
Audit score 45

sf-deploy

jaganpro/sf-skills

Salesforce DevOps automation: validate, deploy, and orchestrate metadata safely using sf CLI v2.

What is sf-deploy?

sf-deploy handles deployment orchestration for Salesforce metadata—dry-run validation, targeted deploys, CI/CD pipeline setup, scratch-org management, and failure triage. Use it when deploying metadata, managing orgs, or troubleshooting deployment errors with sf project deploy commands.

  • Validate deployments with dry-run before execution to catch errors early
  • Deploy metadata via source-dir, manifest, or metadata list with safe test-level selection
  • Perform quick deploys after successful validation to skip re-testing
  • Retrieve metadata from orgs and manage source-tracking workflows
  • Orchestrate deployment sequencing (objects → permission sets → Apex → Flows) to prevent dependency failures
  • Troubleshoot deployment failures and provide triage guidance for common error patterns

How to install sf-deploy

npx skills add https://github.com/jaganpro/sf-skills --skill sf-deploy
Prerequisites
  • sf CLI v2 installed and authenticated to target org
  • sfdx-project.json present in repository root
  • Target org alias configured (verify with sf org list)
  • Appropriate permissions in target org for deployment operations
Claude Code
Cursor
Windsurf
Cline

How to use sf-deploy

  1. 1.Run preflight checks: sf --version, sf org list, sf org display --target-org <alias> --json
  2. 2.Gather required context: target org, deployment scope (source-dir/manifest/metadata), and test level
  3. 3.Validate first with dry-run: sf project deploy start --dry-run --source-dir force-app --target-org <alias> --wait 30 --json
  4. 4.Review validation results and fix any errors before proceeding
  5. 5.Deploy the smallest correct scope using source-dir, manifest, or quick deploy after validation
  6. 6.Verify deployment with sf project deploy report --job-id <job-id> --target-org <alias> --json
  7. 7.Summarize results: what deployed, what failed, what was skipped, and next safe actions

Use cases

Good for
  • Validate a metadata change set before deploying to production
  • Deploy custom objects and fields in correct order to avoid permission set failures
  • Set up CI/CD gates with dry-run validation and test-level selection
  • Quickly deploy after a successful validation job without re-running tests
  • Retrieve metadata from a sandbox and manage source-tracking org workflows
Who it's for
  • Salesforce DevOps engineers managing release pipelines
  • Release managers orchestrating multi-step deployments
  • Developers troubleshooting deployment failures
  • CI/CD pipeline builders setting up automated Salesforce deployments
  • Architects designing safe rollout sequences across orgs

sf-deploy FAQ

When should I use --dry-run vs. actual deploy?

Always use --dry-run first to validate metadata and catch errors before real deployment. Only deploy after validation succeeds and you've reviewed the results.

What is the correct deployment order for metadata?

Deploy in this order: (1) Custom objects/fields, (2) Permission sets, (3) Apex, (4) Flows as Draft, (5) Flow activation. This prevents dependency and field-level security failures.

When should I use quick deploy instead of full deploy?

Use quick deploy (sf project deploy quick) only after a successful validation job. It skips re-testing and is faster, but only works if validation passed without changes.

What test level should I use for deployment?

Use --test-level RunLocalTests for most deployments. For Apex-heavy changes, consider RunRelevantTests (Spring '26+) if org policy allows. Use NoTestRun only for metadata-only changes in non-production orgs.

How do I troubleshoot a deployment failure?

Check the deployment report for error patterns (FIELD_CUSTOM_VALIDATION_EXCEPTION, INVALID_CROSS_REFERENCE_KEY, etc.), fix the root cause (missing dependencies, broken code, bad test data), and revalidate before retrying.

Full instructions (SKILL.md)

Source of truth, from jaganpro/sf-skills.


name: sf-deploy description: > Salesforce DevOps automation using sf CLI v2. TRIGGER when: user deploys metadata, creates/manages scratch orgs or sandboxes, sets up CI/CD pipelines, or troubleshoots deployment errors with sf project deploy. DO NOT TRIGGER when: writing Apex/LWC code (use sf-apex/sf-lwc), creating metadata XML (use sf-metadata), or querying org data (use sf-data). license: MIT metadata: version: "2.3.0" author: "Jag Valaiyapathy"

sf-deploy: Comprehensive Salesforce DevOps Automation

Use this skill when the user needs deployment orchestration: dry-run validation, targeted or manifest-based deploys, CI/CD workflow advice, scratch-org management, failure triage, or safe rollout sequencing for Salesforce metadata.

When This Skill Owns the Task

Use sf-deploy when the work involves:

  • sf project deploy start, quick, report, or retrieval workflows
  • release sequencing across objects, permission sets, Apex, and Flows
  • CI/CD gates, test-level selection, or deployment reports
  • troubleshooting deployment failures and dependency ordering

Delegate elsewhere when the user is:

  • authoring Apex or LWC code → sf-apex, sf-lwc
  • creating metadata definitions → sf-metadata
  • building Flows → sf-flow
  • doing org data operations → sf-data
  • authoring Agent Script logic → sf-ai-agentscript

Critical Operating Rules

  • Use sf CLI v2 only.
  • On non-source-tracking orgs, deploy/retrieve commands require an explicit scope such as --source-dir, --metadata, or --manifest.
  • Prefer --dry-run first before real deploys.
  • For Flows, deploy safely and activate only after validation.
  • Keep test-data creation guidance delegated to sf-data after metadata is validated or deployed.

Default deployment order

PhaseMetadata
1Custom objects / fields
2Permission sets
3Apex
4Flows as Draft
5Flow activation / post-verify

This ordering prevents many dependency and FLS failures.


Required Context to Gather First

Ask for or infer:

  • target org alias and environment type
  • deployment scope: source-dir, metadata list, or manifest
  • whether this is validate-only, deploy, quick deploy, retrieve, or CI/CD guidance
  • required test level and rollback expectations
  • whether special metadata types are involved (Flow, permission sets, agents, packages)

Preflight checks:

sf --version
sf org list
sf org display --target-org <alias> --json
test -f sfdx-project.json

Recommended Workflow

1. Preflight

Confirm auth, repo shape, package directories, and target scope.

2. Validate first

sf project deploy start --dry-run --source-dir force-app --target-org <alias> --wait 30 --json

Use manifest- or metadata-scoped validation when the change set is targeted.

3. If validation succeeds, offer the next safe workflow

After a successful validation, guide the user to the correct next action:

  1. deploy now
  2. assign permission sets
  3. create test data via sf-data
  4. run tests / smoke checks
  5. orchestrate multiple post-deploy steps in order

4. Deploy the smallest correct scope

# 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. Verify

sf project deploy report --job-id <job-id> --target-org <alias> --json

Then verify tests, Flow state, permission assignments, and smoke-test behavior.

6. Report clearly

Summarize what deployed, what failed, what was skipped, and what the next safe action is.

Output template: references/deployment-report-template.md


High-Signal Failure Patterns

Error / symptomLikely causeDefault fix direction
FIELD_CUSTOM_VALIDATION_EXCEPTIONvalidation rule or bad test dataadjust data or rule timing
INVALID_CROSS_REFERENCE_KEYmissing dependencyinclude referenced metadata first
CANNOT_INSERT_UPDATE_ACTIVATE_ENTITYtrigger / Flow / validation side effectinspect automation stack and failing logic
tests fail during deploybroken code or fragile testsrun targeted tests, fix root cause, revalidate
field/object not found in permsetwrong orderdeploy objects/fields before permission sets
Flow invalid / version conflictdependency or activation problemdeploy as Draft, verify, then activate

Full workflows: references/orchestration.md, references/trigger-deployment-safety.md


CI/CD Guidance

Default pipeline shape:

  1. authenticate
  2. validate repo / org state
  3. static analysis
  4. dry-run deploy
  5. tests + coverage gates
  6. deploy
  7. verify + notify
  • When org policy and release risk allow it, consider --test-level RunRelevantTests for Apex-heavy deployments.
  • Pair this with modern Apex test annotations such as @IsTest(testFor=...) and @IsTest(isCritical=true) as documented in sf-apex.

Static analysis now uses Code Analyzer v5 (sf code-analyzer), not retired sf scanner.

Deep reference: references/deployment-workflows.md


Agentforce Deployment Note

Use this skill to orchestrate deployment/publish sequencing around agents, but use the agent-specific skills for authoring decisions:

  • sf-ai-agentscript for .agent authoring and validation
  • sf-ai-agentforce for Agent Builder / Prompt Builder / metadata config

For full agent DevOps details, including Agent: pseudo metadata, publish/activate, and sync-between-orgs, see:


Cross-Skill Integration

NeedDelegate toReason
custom object / field creationsf-metadatadefine metadata before deploy
Apex compile / review / fixessf-apexcode authoring and repair
Flow creation / repairsf-flowFlow authoring and activation guidance
test data or seed recordssf-datadescribe-first data setup and cleanup
Agent Script build/publish readinesssf-ai-agentscriptagent-specific correctness

Reference Map

Start here

Specialized deployment safety


Score Guide

ScoreMeaning
90+strong deployment plan and execution guidance
75–89good deploy guidance with minor review items
60–74partial coverage of deployment risk
< 60insufficient confidence; tighten plan before rollout

Completion Format

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>