Error overview
You may run into this Salesforce validation error when deploying Layout metadata in Gearset.
An example of the error message in our app would look as below:
"Fields in highlights panel must be a subset of fields in detail section"
Explanation of the error
It is a Salesforce Known Issue in these orgs where the highlights panel is not enabled, or when this feature was deactivated in the org. This then leads to this validation error.
Salesforce explains that: "this scenario can occur if service desk was previously enabled in the production org".
Resolution
In order to deploy the Layout without any issues, you need to re-create it from scratch.
In your source org, clone the Layout that failed the validation. It will copy the highlight panel elements.
Resolution for when a PR fails validation in Gearset Pipeline
Similarly to the steps explained above, do the following:
In the Dev org, clone the Layout that was included in the pull request and failed the validation.
Commit cloned Layout to a new feature branch, and open a new PR from that branch.
It's our understanding that validation of your new PR with cloned Layout should be successful, and allow you to promote the change to the next environment.
This resolution has been verified by our customer who run into this issue previously.
Useful resources
For more context on this error, see Salesforce Known Issues (last updated 17 May 2018).
Disclaimer: This error is returned by Salesforce directly, rather than Gearset. Even so, we offer guidance based on our combined experience with the Metadata API. Where possible, we try to help guide you to fix or avoid this error. In the case that this isn't possible, we may need to direct you to Salesforce support for further clarification.