License requirements:
To get access to this feature, teams need to have both the Automation license and Revenue Cloud add on.
Gearset Pipelines supports Salesforce Revenue Cloud configuration data for deployment alongside regular metadata in your Pipelines process, using the same git repository.
Note: We'll use the term Revenue Cloud in the following article to refer to both CPQ and RCA configuration data.
Revenue Cloud configuration can be deployed through the Pipeline in the same PRs as standard metadata, and the Gearset External ID fields will be deployed and kept in sync across environments through the deployment process.
To include Revenue Cloud in your Pipelines process, the following setup steps are recommended:
Before you start: Ensure that Gearset External IDs for all Revenue Cloud configuration data are aligned across all orgs in which Revenue Cloud is actively used. If this is not the case, please see and follow this guide to align them correctly:
Setting up your orgs for successful Revenue Cloud deployments via a full copy sandbox refresh approach
Populate the Revenue Cloud metadata into the master branch of your repo. All Revenue Cloud configuration data you intend to be configurable through your Pipelines process should be included here. To populate Revenue Cloud into the repo, use the following guide:
Note: To ensure good performance from your repo, we recommend that the size of Revenue Cloud configuration in your repository should not exceed 1GB. Typically, this would correspond to an upper limit of approx. 1 million pricebook entries, or around 20,000-30,000 products.
Ensure that this Revenue Cloud configuration data is aligned across all branches which underpin orgs in which Revenue Cloud is actively used.
If using a new repo with a new pipeline, push Revenue Cloud config data to the master branch alongside metadata, then create your other Pipelines branches from this to ensure alignment.
If you have an existing repo, create PRs to push the Revenue Cloud config data from the master branch to the other branches in use - as the External IDs are already aligned, this should simply ensure that the config data in the branch matches that already in the orgs.
Create new CI jobs for each environment in which Revenue Cloud is actively used alongside core metadata to include the Revenue Cloud metadata types required, alongside with the configuration data objects.
Note1: For CPQ, ensure you also have the CPQ managed package selected in the right end side of your metadata filter, along with any metadata required for CPQ deployments.
Note2: If you wish to use existing CI jobs, the first run for the job after adding Revenue Cloud components to the metadata filter will attempt to deploy all Revenue Cloud items in the repo to the target.
As such, new CI jobs are strongly recommended.Add these new CI jobs into your pipeline, replacing the original CI jobs in the Pipeline. Any PRs open against the branches here will be preserved. If setting up your pipeline for the first time, see the following document and incorporate Revenue Cloud into your CI jobs here when setting them up: Setting up your first Gearset pipeline.
Start using Revenue Cloud in Pipelines! You can create PRs with Revenue Cloud configuration data and Salesforce metadata - on merging to the first branch and deploying to the org, the PR is raised against the next Pipeline environment in the same way as with any other PR.
We recommend that teams use Delta CI with Pipelines for Revenue Cloud in the same way as is recommended for metadata-only jobs. This way, only the new changes will be deployed when you push changes.
There are some differences in behaviour which should be noted between the core pipelines process and deployments which include Revenue Cloud:
PR Validations - Validations will be run on metadata in a PR, but not on the Revenue Cloud config data. If the metadata config passes validation, the PR may be merged and deployment started, but if there are issues with the Revenue Cloud deployment, this may cause the deployment to be only partially successful.
Partial success due to Revenue Cloud deployment failure. If a Revenue Cloud deployment fails to deploy some config data, this status is shown in the Pipelines UI for the deployment. Any errors here can then be found and remedied as needed.
Note: When deploying Revenue Cloud with pipelines, if you add a new field to a single Revenue Cloud Product then Gearset will add this new field to all of your Revenue Cloud Products in order to keep them in sync. This might show in the CI Job History as deploying many more Revenue Cloud components than expected but is a required step by Gearset to keep your org up to date. Gearset will add this new field as empty so that it doesn't affect the org and these additions will not show in the git commit history of the PR.