With Gearset, comparing orgs and creating deployment packages has never been easier. But sometimes you don’t have all the changes you want to deploy ready just yet, or you want to get input from a colleague on what to include in the release. That’s where draft deployments come in.
Save as you go
With draft deployments, you can begin adding components to your deployment package, save your progress, and return to it at a later date. Drafts can be updated multiple times until you’ve added everything you want. You can even refresh your comparison to change your metadata filter part-way through, although this refresh will only allow you to save another draft, rather than saving over your saved draft.
Once you’ve got all the components you want, proceed with the deployment as usual to release your changes.
Build deployments collaboratively
Team members can use draft deployments to collaboratively build deployment packages. Once you’ve made your changes, simply save your draft.
Team members share draft deployments, so one of your team can then jump in and add their own components. When the package is complete, and everyone’s work has been included, you can validate the package and deploy the release, or schedule it for automatic deployment at a later time.
Requirements for being able to refresh team member's comparison filter
Note that to refresh a team member's comparison filter, you will need to have at least comparison level access delegated to you for both the source and target. If a team member is no longer in the same Gearset team, you will not be able to load the draft that the team member created with the orgs he or she owned.
More information on delegating permissions can be found in this article: Access levels in Gearset.
How to save a draft deployment
Run a comparison between two orgs.
Once you’ve selected some objects, click
Save draft deployment.... Choose aDraft name, and clickSave as new.Your selections and the comparison result will be saved in the Draft deployments page (found under
Metadata deployments).
How to edit a saved draft deployment
Go to your Draft deployments (under
Metadata deployments).Click
Open draft.Continue building your deployment.
To update your draft, click
Save draft deployment....
Note: When editing an existing draft that you've opened, you'll be given the option to Update draft deployment or Save as a new draft deployment, as seen below:
How to collaborate on a team member's draft deployment
Go to your Draft deployments.
You’ll be able to see the drafts for anyone in your team, who created the draft, and who made the last edit. Click
Open draftto begin editing.When you’re done editing, click
Save draft deployment...to save your changes.
Note: While all team members can edit a draft deployment, to actually deploy it you will need to have Deployment level access for the target org delegated to you by the owner of the target org connection.
If the target is Git, only the person who created the draft deployment can deploy it.
How to clone a draft deployment
License requirements:
This feature is available in our Teams & Enterprise licenses.
You can clone draft deployments to quickly select the same components again, or to build a slightly different deployment package.
Click
Clone draft....Choose the source and target org for which you want to build this deployment. The
Metadata filtertab will allow you to choose between the original filter chosen, or a new filter of your choosing.Click
Run comparison. When the comparison finishes, all the items in the draft being cloned will be preselected for you.
Filtering draft deployments by date
By default, the draft deployment history will display drafts created in the last 10 days. You can change this filter view by clicking on the date range to the right of the filter box.
Known limitations
Gearset renders the comparison as a list of top level items and its expandable subcomponents.
When creating a draft user can tick top level items and the expandable subcomponents. However when the draft comparison is re-opened, the ticked subcomponents may not be visible until you expand the top level item that contains the subcomponents.
For example, Profile is a top level item in the comparison. Profile: Layout Assignment is an expandable subcomponent. When you re-open a draft that has the ticked Profile: Layout Assignment , you won't see it upon loading the draft comparison. You will need to expand the parent Profile before you can see the item ticked.