SUMMARY.md

Table of contents

• Overview

Getting Started

• Pre-Requisites
• Install sfp
  • Install sfp community edition
  • Install sfp-pro
• Configure Your Project
• Build & Install an Artifact
• Configuring LLM Providers
• Congratulations!
• Docker Images
  • sfp-pro
    • Automated Image Synchronization to Your Registry
    • Migrating from sfp community edition to sfp pro edition

CONCEPTS

• Overview
• SF CLI vs. SFP
• Domains
• Packages
• Supported package types
  • Unlocked Packages
  • Org-Dependent Unlocked Packages
  • Source Packages
  • Diff Package
  • Data Packages
• Artifacts
• Package vs Artifacts
• Identifying types of a package
• Dependency management
• Transitive Dependency Resolution
• Destructive Changes

configuring a project

• Project structure
• Setup Salesforce Org

Development

• Development Workflow
• Development Environment
• Pull Changes from your org
• Push Changes to your org
• Running Apex Tests
• String Replacements
• Creating a package
• Defining a domain
  • Release Config
• Dependency Management
  • Expand Dependencies
  • Shrink Dependencies
  • Explain Dependencies

Analysing a Project

• Overview
• Duplicate Check
• Compliance Check
• AI Assisted Architecture Analysis
• AI Assisted Insight Report
• CI/CD Integration

Validating a change

• Overview
• Different types of validation
• AI-Assisted Error Analysis
• Limiting Validation by Domain
• Validation Scripts
• Controlling validation attributes of a package
  • Always sync a package during validation
  • Check-Only Deployment Mode
  • Skip Testing
  • Skip Coverage Validation
  • Test Synchronously

BUILDING ARTIFACTS

• Overview
• Determining whether an artifact need to be built
• Building a domain
• Building an artifact for package individually
• Limiting artifacts to be built
• Controlling aspects of the build command
  • Ignoring packages from being built
  • Building a collection of packages together
  • Selective ignoring of components from being built
  • Use of multiple config file in build command
• Configuring installation behaviour of a package
  • Always deploy a package
  • Skip Install on Certain Orgs
  • Optimized Installation
  • Pre/Post Deployment Script
  • Reconciling Profiles
  • PermissionSet Assignment
  • Updating Picklist
  • Entitlement Deployment Helper
  • Field History & Feed Tracking
  • Aliasfy Packages
    • Aliasfy Packages - Merge Mode
  • String Replacements
  • State management for Flows

Installing an artifact

• Overview
• Controlling Aspects of Installation
• Applying attributes of an artifact
• String Replacements During Install
• BuiltIn Deployment Helpers
  • PermissionSet Group Awaiter

publishing and fetching artifacts

• Publish Artifact
• Fetching Artifacts

Releasing artifacts

• Overview
• Release Definitions
• Generating a release definition
• Patching Releases
• Generating a changelog

Environment Management

• Environments
  • Org Registration
  • JIT Sandbox Authentication
  • Environment Locking
  • Accessing Environments
  • Managing Environment-Specific Metadata
• Pools
  • Scratch Org Pools
    • Defining a pool
    • Setting up your Salesforce Org for Scratch Org Pools
    • Pool Operations
      • Preparing pools
        • Handling dependencies
      • List Scratch Orgs in a pool
      • Fetch a scratch org
      • Delete Pools
  • Sandbox Pools
    • Sandbox Pool Initialization
    • Fetch a Sandbox from Pool
    • Monitor Sandbox Pools
• Review Environments
  • Commands
    • Fetch a Review Environment
    • Check Review Environment Status
    • Extend a Review Environment
    • Transition Review Environment Status
    • Unassign a Review Environment
  • Considerations
• Sandbox
  • Create Sandbox
  • Delete Sandbox
  • List Sandbox
  • Login to Sandbox
  • Update Sandbox

AUTH MANAGEMENT

• Overview
• Server Authentication
• SFDX Auth URL
• Connected Apps
• Community Edition

COLLABORATE

• Project
• Integrations

---

• API Reference
  • Health
  • Authentication
  • Token
  • Salesforce
  • Team
  • Users
  • Tasks
  • Key Value
  • Repository
  • Integrations
  • MCP
  • WebHooks

Metrics

• Available Metrics
• Custom Metrics
• Configuring Collectors
  • sfp Server
  • Datadog
  • Splunk
  • New Relic
  • StatsD

Helpers

• Managing Shared Resources

CLI REFERENCE

• Core
  • Build
  • Quickbuild
  • Publish
  • Install
  • Release
• Advanced
  • Validate
  • Artifacts
  • Changelog
  • Impact
  • Pool
  • Metrics
  • Repo
  • Release Definition
• Server
  • Init
  • Start
  • Stop
  • Status
  • Update
  • Health
  • Logs
  • Scale
  • Application Token
  • Artifacts
  • Auth
  • Builds
  • Doc Store
  • Environment
  • Key-Value
  • Org
  • Pool
  • Project
  • Release Definition
  • Repository
  • Review Environments
  • User
  • Webhook
• Utilities
  • Apex Tests
  • Flow
  • Dependency
  • Profile

FAQs

• Common Errors
  • Org Shapes
  • Troubleshooting Unlocked Packages Build Failure Due to Code Coverage
• Common Questions
  • Auto-Enable Trace Logging in CI/CD
  • Email Templates Deployment: Classic vs Lightning
  • Dealing with Long Build Times in Salesforce
  • Standard ValueSets and unlocked packages
  • Common Issues encountered with aliasfied packages
  • API Version
  • Understanding alwaysDeploy and skipIfAlreadyInstalled in Deployment Pipelines
• sfp versioning and upgrade Process

---

• References
• Legal
  • Terms of Service for sfp
  • Terms of Service for 'sfp-pro' Software