Update and Deploy Lightning Communities with ExperienceBundle (Developer Preview)

The ExperienceBundle metadata type provides human-readable, text-based representations of the different Community Builder settings and site components, such as pages, branding sets, and themes. Whether it’s for your own org or you’re a consulting partner or ISV, quickly update and deploy Lightning communities using your preferred development tools, including Salesforce Extensions for VS Code, Salesforce CLI, Workbench, or your favorite IDE or text editor.
Where: This change applies to Lightning communities accessed through Lightning Experience and Salesforce Classic in Developer editions. This feature is available only in Developer orgs and can’t be used to deploy Lightning communities to a production org.
Note

Note

The ExperienceBundle type is available as a developer preview. The ExperienceBundle type isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. All commands, parameters, and other features are subject to change or deprecation at any time, with or without notice. Don't implement functionality developed with these commands or tools. You can provide feedback and suggestions on using the ExperienceBundle type in the Community Cloud group in the Trailblazer Community.

Why: Previously, the Network, CustomSite, and SiteDotCom metadata types combined to define a community. However, retrieving the SiteDotCom type produces a binary .site file, which isn’t human readable. By retrieving the ExperienceBundle type instead of SiteDotCom, you can extract granular community metadata in a human-readable format, contained in a three-level folder structure.

The experiences folder contains all the Lightning communities in your org. Each community folder contains subfolders that represent the different components that you access in Community Builder. Edit the .json files on your local machine or scratch org, and then quickly deploy your changes.

Three-level folder structure

How: To use the ExperienceBundle metadata type, from Setup, enter Communities Settings in the Quick Find box, and then select Communities Settings. Select Enable ExperienceBundle Metadata API, and save your changes.