Gearset allows users to exclude unlocked packages from the comparisons run via Compare and deploy as well as from any custom metadata filters, including those used in CI jobs.
Default configuration
By default, all metadata detected as part of an unlocked package is included in Gearset comparisons.
However, we understand that sometimes you may want to exclude unlocked package metadata from your comparison.
Within the packaging sidebar on the right hand side of the filter, there is the option to Exclude unlocked packages from your comparison.
In brackets we're showing the number of distinct unlocked packages identified across the two environments.
On the below example, we've amended the default behaviour and excluded unlocked packages from the filter (by enabling the toggle):
You can apply this setting to existing metadata filters, including those created before this feature was introduced.
Expected behaviour when retrieving unlocked package metadata
Even if the “Exclude unlocked packages” option is enabled:
• Any item that is part of an unlocked package in only one environment will still be retrieved and shown in the comparison results.
This ensures that discrepancies between environments are still visible.
This applies even when option Exclude unlocked packages is enabled.
Limitations
Currently, there isn't a way within Gearset to filter out only specific unlocked packages.
This setting in our app cannot filter out specific packages - to achieve this you must exclude all from your comparison.
Feedback
Have a use case that isn’t covered here? We’d love to hear from you! Please get in touch with the team to share your feedback.