Salesforce DX Developer Guide

How Salesforce Developer Experience Changes the Way You Work
Enable Dev Hub Features in Your Org
Project Setup
Authorization
Metadata Coverage
Scratch Orgs
Sandboxes
Track Changes Between Your Project and Org
Development
Build and Release Your App
First-Generation Managed Packages
Second-Generation Managed Packages
Partner Licensing Platform (Developer Preview)
Unlocked Packages
What’s a Package
Package-Based Development Model
Before You Create Unlocked Packages
Know Your Orgs
Create Org-Dependent Unlocked Packages
Workflow for Unlocked Packages
Configure Packages
How We Handle Profile Settings in Unlocked Packages
Create a Package
Generate the Package
Generate a Package Version
Simplify Package Development by Creating and Specifying an Org Shape
Use Branches in Unlocked Packaging
Skip Validation to Quickly Iterate Package Development
Target a Specific Release for Your Unlocked Packages During Salesforce Release Transitions
Code Coverage for Unlocked Packages
Release an Unlocked Package
Update a Package Version
Hard-Deleted Components in Unlocked Packages
Delete an Unlocked Package or Package Version
View Package Details
Push a Package Upgrade
Install a Package
Migrate Deprecated Metadata from Unlocked Packages
Uninstall a Package
Transfer an Unlocked Package to a Different Dev Hub (Beta)
Continuous Integration
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Simplify Package Development by Creating and Specifying an Org Shape

If your package’s metadata depends on a complex set of features, settings, or licenses, it can be difficult to declaratively specify these dependencies in a scratch org definition file. Instead, create an org shape of your production org, or another development org, and specify that source org’s ID in your scratch org definition file. During package creation, we mimic the source org’s environment when we build and validate your package’s metadata.

This feature depends on Org Shape for Scratch Orgs, which is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms.

Note

Org Shape for Scratch Orgs is a beta feature. It doesn’t currently include every feature, setting, and limit. In these cases, you must manually specify these features and settings in your scratch org definition file. Before using this feature, get familiar with how Org Shape for Scratch Orgs works.

Then enable the scratch org setting in your source org, generate the org shape, and edit your scratch org definition file to include the org name and 15-character source org ID.

1{
2  "orgName": "Acme",
3  "sourceOrg": "00DB1230400Ifx5"
4}