Regularly, Salesforce releases new versions of the API for preview. During this period there are Sandboxes that are on a new API version (e.g. v61 or Summer '24), when the rest of the Production orgs are on another API version (e.g. v60 or Spring '24).
This document explains how Gearset handles the version changes.
Once Salesforce releases the new API for preview, Gearset releases support for the new API (e.g. v61) as soon as possible. At this stage, Gearset does not make the new version the default API, therefore automation jobs continue to use the previous API version and nothing changes.
People wanting to test the new v61 can set it explicitly in their comparisons or CI automation jobs.
Amending metadata API version in 'Compare and deploy'
In manual Compare and deploy, you can select the API version in the Manage custom filters... option.
You'll see the setting called API version - click on the drop down, and select your desired API version. This API version will be used in your comparison.
If the comparison already started, you can change the API version by clicking on the cog button as shown below.
Next, click on the drop down on the right side of the popup API version and select the desired version.
Amending the API version in a CI job's filter
If it's a CI job, you can edit the settings and change it in the Metadata filter tab.
Once Salesforce releases a new API version for general availability, Gearset will then make the new version (e.g. v61) the default - that is as soon as we provide support for that new API version.
And from that point onwards, all automated jobs will start retrieving with the newest version of the API.
For more information on how to amend the API version in 'Compare and deploy' or CI jobs in our app, please check this article:
How do I change the API version that Gearset uses?