Feature guides

Learn what you can do with Gearset

Kevin Boyle avatar Jason Mann avatar Stephen Chambers avatar +30
101 articles in this collection
Written by Kevin Boyle, Jason Mann, Stephen Chambers and 30 others
Comparisons and deployments

An introduction to Gearset Live Comparisons

A faster way to compare and deploy in Gearset
Valerio avatar
Written by Valerio
Updated over a week ago

Which metadata differences are the same between different Gearset comparisons

In delta CI, combining and cloning packages a second comparison is run.
Valerio avatar
Written by Valerio
Updated over a week ago

Improved XML difference visualization

Documenting improvements made in June 2022
Gwilym Kuiper avatar
Written by Gwilym Kuiper
Updated over a week ago

Gearset suggested Apex tests

David Emmerson avatar
Written by David Emmerson
Updated over a week ago

Managing Salesforce org connections

Add, remove, and re-authorize saved connections to your Salesforce orgs
Jason Mann avatar
Written by Jason Mann
Updated this week

Custom metadata filters

Create and save metadata filters to specify which items to retrieve and compare with Gearset
Jason Mann avatar
Written by Jason Mann
Updated over a week ago

Using regex in custom metadata filters

Including and excluding items from your filter
Catherine Bacon avatar
Written by Catherine Bacon
Updated over a week ago

Configuring comparisons

Choose your source and target metadata location and compare them for differences
Jason Mann avatar
Written by Jason Mann
Updated over a week ago

Configuring SFDX scratch orgs with Gearset

Create, compare, and develop your Salesforce DX scratch orgs from within Gearset
Jason Mann avatar
Written by Jason Mann
Updated over a week ago

Comparing managed package metadata with Gearset

How to compare and deploy changes to your managed packages
Jason Mann avatar
Written by Jason Mann
Updated over a week ago

Using regex to filter comparison results

Ali Daw avatar
Written by Ali Daw
Updated over a week ago

An introduction to Gearset's problem analyzers

Understanding how Gearset's problem analyzers help make your deployments more reliable
Jason Mann avatar
Written by Jason Mann
Updated over a week ago

Setting Apex test levels

A guide to running tests when deploying with Gearset
Jason Mann avatar
Written by Jason Mann
Updated over a week ago

Draft deployments

Save org metadata snapshots and share drafts for simple collaboration on deployments in development
Valerio avatar
Written by Valerio
Updated over a week ago

Validated packages

Test your deployment prior to release, utilise quick deploy, schedule automatic deployment, and verify team members' packages
Jason Mann avatar
Written by Jason Mann
Updated over a week ago

Integrating with Jira (hosted)

Add your Jira ticket reference and Gearset will automatically post updates to your Jira ticket and provide a direct link to your deployments
Valerio avatar
Written by Valerio
Updated over a week ago

Comparison history

View a history of previous comparisons and create deployments from them
Valerio avatar
Written by Valerio
Updated over a week ago

Deployment history

View a history of previous deployments, download deployment reports, start a rollback or clone a package
Valerio avatar
Written by Valerio
Updated over a week ago

Connecting to an on-prem version of Jira

This article will take you through the steps of connecting a Self-hosted version of Jira to Gearset
Claudia McPhail avatar
Written by Claudia McPhail
Updated over a week ago

Deployment rollback

Perform full and partial metadata rollback for any org
Michael Krumwiede avatar
Written by Michael Krumwiede
Updated over a week ago

Cloning deployment packages

Quickly migrate changes down your release pipeline by cloning a previous deployment
Valerio avatar
Written by Valerio
Updated over a week ago

Combine multiple deployments into one single deployment package

Valerio avatar
Written by Valerio
Updated over a week ago

Deploy package straight to target

Skip the comparison and analysis steps by deploying an existing package to a new target from the deployment history page
Kevin Slattery avatar
Written by Kevin Slattery
Updated this week

Using environment variables in Gearset

How to replace specified fields in metadata with custom values during a deployment
Sam Williams avatar
Written by Sam Williams
Updated over a week ago
Version control

Integrating with Azure DevOps Server

Jonathan Plumridge avatar
Written by Jonathan Plumridge
Updated over a week ago

Integrating with GitHub

Deploy to and from your hosted GitHub source control provider
Valerio avatar
Written by Valerio
Updated this week

Integrating with Bitbucket

Deploy to and from your hosted Bitbucket source control provider
Valerio avatar
Written by Valerio
Updated over a week ago

Managing source control connections in Gearset

Add and remove saved connections to your source or version control repositories
Valerio avatar
Written by Valerio
Updated over a week ago

Restricting your team’s source control access

A guide to controlling your team's ability to connect to and interact with source control in Gearset
Matt Cree avatar
Written by Matt Cree
Updated over a week ago

Integrating with GitLab

Deploy to and from your hosted GitLab source control provider
Valerio avatar
Written by Valerio
Updated over a week ago

Integrating with GitHub Enterprise

Deploy to and from your own GitHub instance
Dan Fenner avatar
Written by Dan Fenner
Updated over a week ago

Integrating with Azure DevOps

Deploy to and from your hosted Azure DevOps source control provider
Valerio avatar
Written by Valerio
Updated over a week ago

Integrating with Bitbucket Server

Deploy to and from Bitbucket Server
Ali Daw avatar
Written by Ali Daw
Updated over a week ago

Integrating with AWS CodeCommit

Deploy to and from AWS CodeCommit
Dan Fenner avatar
Written by Dan Fenner
Updated over a week ago

Integrating with self-managed GitLab

Deploy to and from your own GitLab instance
Gwilym Kuiper avatar
Written by Gwilym Kuiper
Updated over a week ago

How to set up a new source control repository

A practical guide to setting up a new source control repository, ready to use as the source of truth in a Gearset release pipeline
Toby Newman avatar
Written by Toby Newman
Updated over a week ago

Pilot feature: Source control setup for LWC test runs

Instructions on the correct format and setup that your git repository needs to run LWC tests as part of a CI job run in Gearset.
Stephen Chambers avatar
Written by Stephen Chambers
Updated over a week ago

Filtering comparison results by package.xml

How Gearset applies package filtering to your comparison results
Jason Mann avatar
Written by Jason Mann
Updated over a week ago

Create pull requests from deployment summary

Valerio avatar
Written by Valerio
Updated over a week ago

What does Gearset’s repo dependency cleaner do?

Valerio avatar
Written by Valerio
Updated over a week ago

Getting started with AWS CodeCommit webhooks

How to set up a CI job to deploy changes from an AWS CodeCommit repository when the source branch changes
Ali Daw avatar
Written by Ali Daw
Updated over a week ago

Managing status check rules in GitHub

How to enable or disable the requirement for Gearset-related status checks to pass before merging a pull request in GitHub
Gabriel Cowley avatar
Written by Gabriel Cowley
Updated over a week ago
Automation and CI

Continuous integration

Automatically deploy changes from one metadata location to another with CI and CD from Gearset
Valerio avatar
Written by Valerio
Updated over a week ago

How do I add Gearset notifications to a Slack channel?

Update your Slack channel when action is needed or just to get visibility.
Samuel Crossland avatar
Written by Samuel Crossland
Updated over a week ago

EventBridge configuration for the users using AWS CodeCommit

Additional configuration required for triggering CI validation upon creation of pull request for the users using AWS CodeCommit.
Amrutraj Patil avatar
Written by Amrutraj Patil
Updated over a week ago

Delta CI

Also known as commit-by-commit deployment
Valerio avatar
Written by Valerio
Updated over a week ago

Transferring CI job ownership

Ben Scabbia avatar
Written by Ben Scabbia
Updated over a week ago

Outgoing webhooks in continuous integration jobs

How to add outgoing webhooks to CI jobs to trigger third party services
Catherine Bacon avatar
Written by Catherine Bacon
Updated over a week ago

Standard CI outgoing webhook payload

An example of a payload format for your CI jobs
James Potter avatar
Written by James Potter
Updated over a week ago

Integration with Glip

James Potter avatar
Written by James Potter
Updated over a week ago

How to spin up Salesforce scratch orgs from CI jobs

Deploy metadata from source control to a new scratch org with Gearset CI
Valerio avatar
Written by Valerio
Updated over a week ago

Problem analyzer templates

How to create problem analyzer templates and assign them to CI jobs
Ana Juvandes avatar
Written by Ana Juvandes
Updated over a week ago

Org monitoring: automating org change tracking and metadata backup

Get daily org snapshots, change reports and audit history, take on-demand metadata backups and inspect Apex code quality
Jason Mann avatar
Written by Jason Mann
Updated over a week ago

Automating Salesforce org unit testing

Run your tests daily, track code coverage, and get notified of test failures
Jason Mann avatar
Written by Jason Mann
Updated over a week ago

Configuring static code analysis

Gearset's automatic static code analysis allows you to examine your Apex code for issues during your deployment
Stephen Chambers avatar
Written by Stephen Chambers
Updated over a week ago

How do I add Gearset notifications to a Microsoft Teams channel?

Update your Microsoft Teams channel during continuous integration, change monitoring or test monitoring when action is needed
Kevin Boyle avatar
Written by Kevin Boyle
Updated over a week ago

Integrating Gearset with CruiseControl

See your Salesforce org test results on your desktop
Jason Mann avatar
Written by Jason Mann
Updated over a week ago
Data backup

Can I backup a formula field?

Data backup and why it's not possible to backup a calculated field.
Valerio avatar
Written by Valerio
Updated over a week ago

Restoring a record that has been merged in Salesforce

How can you restore a Salesforce record to its original state after merging it?
Claudia McPhail avatar
Written by Claudia McPhail
Updated over a week ago

How can I view particular record ID in the data backup runs?

Look for a specific record ID in Gearset's data backup runs.
Valerio avatar
Written by Valerio
Updated over a week ago

Restoring deleted records with related records

Restoring records and their associated deleted child records
Alex Walter avatar
Written by Alex Walter
Updated over a week ago

Restoring changed fields from a data backup job

Restoring unwanted changes in specified fields in an object, while leaving the good changes in place
Alex Walter avatar
Written by Alex Walter
Updated over a week ago

Creating your first data backup job

Backup your metadata and data records with Gearset
Sravani Bhattiprolu avatar
Written by Sravani Bhattiprolu
Updated over a week ago

Deploying and restoring Files and Attachments

Gearset can deploy the attachments for the other records you're deploying
Andrew Hunter avatar
Written by Andrew Hunter
Updated over a week ago

A data backup job's first run

How new data backup jobs back up record data and files
Valerio avatar
Written by Valerio
Updated over a week ago

Restoring data from a data backup job

Use Gearset's data backup jobs to easily restore lost or corrupted data to your Salesforce orgs
Valerio avatar
Written by Valerio
Updated over a week ago

Restoring single records from a data backup job

Use Gearset's data backup jobs to easily restore a single lost or corrupted record to your Salesforce orgs
Valerio avatar
Written by Valerio
Updated over a week ago

Restoring metadata from a data backup job

Use Gearset's data backup jobs to easily restore configuration settings in your orgs
Jason Mann avatar
Written by Jason Mann
Updated over a week ago

Data backup restore How-To: Restoring a deleted Opportunity and its Account

A data restore example with dependencies
Alex Walter avatar
Written by Alex Walter
Updated over a week ago

Transferring Data backup job ownership

Has a colleague moved from the team or changed roles? Change the owner of any existing data backup jobs
Aimee-Beth Burley avatar
Written by Aimee-Beth Burley
Updated over a week ago

Deleting a record from a data backup job

How to remove records from your backups as part of your compliance or legal requirements
Jason Mann avatar
Written by Jason Mann
Updated over a week ago

Backup support for Knowledge Articles

How Gearset backs up __kav records, KnowledgeArticleVersion
Alex Walter avatar
Written by Alex Walter
Updated over a week ago

Backup support for Custom Metadata Types ("__mdt" objects)

How data backup jobs back up Custom Metadata Types and how best to monitor changes
Alex Walter avatar
Written by Alex Walter
Updated over a week ago