It can be frustrating to construct the perfect metadata deployment, only to realise after it fails validation that you forgot to include permissions. With Gearset you can now configure your on-demand comparisons to always include Profile or Permission Set metadata whenever you add Custom Object or Layout metadata to your comparisons.
Note: Currently this automatic inclusion will only run on comparisons utilising the On-demand or 'Compared Types' filter, and not any named default or custom filters. In future we plan to expand it to operate across more filters.
Configuring your on-demand comparison preferences
You can access this feature by customising the on-demand filter within Compare & Deploy. Just start an on-demand comparison, then once on the comparison screen, navigate to the custom filter.
Then once in the filter editor, navigate to one of the supported metadata types (in this example we will use Custom Object) and you will see two new buttons.
These buttons, when selected, will bring in profile and/or permission set metadata into a comparison alongside the metadata you configured these settings on, whenever that metadata type is brought into current and future on-demand comparisons.
In future comparisons it will continue to bring in profiles and permission sets automatically when you add the metadata type in the sidebar, without you needing to navigate to the Manage Custom Filters screen each time.
This setting is a per-user preference rather than being associated with a specific comparison. Once you've set it once, it will track across all your future comparisons without affecting other users in your organisation, even if they load up a previous comparison where you had the setting configured on.
This setting is currently supported on Custom Object and Layout metadata, and is configured individually across each type.
In the video, we walk through selecting the source and target orgs to get ready for a comparison. We then choose the On-demand filter and hit Compare now.
Once the comparison loads, we filter for Custom Object. By doing this you’ll notice that Profile and Permission Set metadata types are automatically included.
Next, we click the filter icon next to Custom Object to open the Metadata Filter view, where you can see that Include Profile Dependencies and Include Permission Set Dependencies are both selected.