Troubleshooting with Gearset has just become a whole lot easier!
You no longer have to spend time explaining the exact metadata filter settings you are using whenever you run into an issue with your comparison. Instead, one click of a button shares your read-only comparison results with us - and we can get investigating!
What type of comparisons can I share with Gearset?
You can share your comparison from different pages in our app, such as, Deployment history, Comparison history, CI dashboard, or Monitoring dashboard.
These break down into three categories:
Manual comparisons (e.g. org to org, or Git to org)
These comparisons are run via Compare and deploy page, and the history of these comparisons can be found on Comparison history, or on Deployment history page (depending on whether you've only run the comparison or already compared and deployed the changes).
Deployment history also includes all manual comparisons (and deployments) made from Deployment pipelines page
Example: comparisons between Dev orgs (source) and feature branches (target) - for when you commit changes to the feature branches in order to open a PR and promote it via Gearset Pipeline.
Comparison used to run CI jobs
CI job comparisons can be found on CI dashboard page in our app.
Comparisons used for org monitoring jobs
Comparisons for change monitoring jobs are located in Change monitoring dashboard.
Sharing your manual comparison run via "Compare and deploy"
From the comparison screen, you can access the sharing button.
The "Share comparison" can be found underneath the table of metadata differences, next to the toggle for switching between the different object views.
It will open up a pop-up window with Generate sharing details button. Click on it.
Then select Copy button. It will copy the URL link to clipboard. Share the link with our support team on the chat you opened (or you can send it via email).
A short video to demonstrate how to share the comparison with our support:
Sharing your CI job comparison
To share a comparison from a CI job, navigate to your CI dashboard.
Find the CI job in question, and click on the View history button (right next to the job "run" button).
Then find the CI job run you're looking for and select View comparison.
Note: For the CI job runs that have failed or are showing an "Error" status, it's an expected behaviour for the button to view comparison to be unavailable (greyed out).
Once you have the comparison loaded, follow the process of generating sharing details and copying the URL link to clipboard.
Sharing your org monitoring comparison
On your Monitoring dashboard find the job in question and select View history button (similarly like for the CI job).
Then click on View comparison to preview the comparison for the job.
Once you have the comparison loaded, follow the process of generating sharing details and copying the URL link to clipboard.
What does "read-only" mean?
Gearset will create a read-only view of your comparison results where we can review the metadata in your source and target. This does not give us access to your actual source and target environments, so we won't be able to make any changes to your orgs - it only allows us to view the same comparison screen as you.
Because this comparison is read-only, we won't be able to include additional items in your metadata filters or deploy any changes.
Note: If you made some selections in the comparison, the selections won't be visible to us, but at least we will be able to view comparison results (all the metadata that was retrieved) to help you with troubleshooting.
How long does Gearset keep the access to my shared comparison?
By default, your comparison can be viewed by our team for 10 days from the day it was shared.
After that the access to the comparison will expire, and you'd need to share it with us again should there be a need for that.
What advantages are there to sharing your comparison?
Sharing your comparison with us can greatly speed up the time it takes for us to help you with common issues, such as:
Finding missing items that are nested subcomponents
Ensuring you have the correct metadata filter settings for your desired items
Helping you include dependencies that are causing your deployments to fail