Gearset

Oli Lane

Adam Bosak

Terrance Harris

Gearset Pipelines, CI jobs, org monitoring, unit testing and using the Gearset APIs

Automate

Pipelines

Use Gearset Pipelines to visualize and control your release process from start to finish

An introduction to Gearset Pipelines

A step-by-step guide on how to create your first pipeline using our setup wizard.

Creating your first Pipeline using the setup wizard

Step by step guide on how to add a new CI job Gearset Pipelines page

Creating CI jobs in Gearset Pipelines

Guidance on how to add developer sandbox environments to your Pipeline

How to add a Developer Sandbox to your Pipeline

Getting your features from your dev sandbox into Gearset Pipelines and getting them propagated through your environments.

Promoting your first features in Gearset Pipelines

What happens behind the scenes in a Pipeline

Promoting a change through your Pipeline

This article describes how to use pipelines and start your work with a user story.

Starting with your user story and creating feature branches in Pipelines

Understanding why we support one branching model and how it works

The Gearset Pipelines branching model

An overview of the new functionality to handle Long term projects in Gearset Pipelines and how that will affect your workflow

Long term projects in Gearset Pipelines

What does the "Auto delete feature branches" toggle do in your Gearset Pipeline settings?

Auto delete feature branches toggle

What does the Copy VCS Reviewers toggle do in pipeline settings?

Copy VCS Reviewers toggle

Set up templates for your feature branches when creating new features associated with Jira tickets or Azure work items

Feature branch format - optional Pipeline setting

Locate the reviewer assigned to a pull request within Gearset's pipelines UI.

Locating reviewers added to an open pull request (PR)

A guide to stay in sync using ‘Updates’ in Gearset Pipelines. Keep Sandboxes in sync with the source of truth and preserve work in progress.

Getting started with Developer Sandbox Updates in Pipelines

Guidance for customers migrating from the legacy workflow (syncing dev sandboxes via static environments) to the new ‘Updates’ functionality

Migrating from legacy back propagation to Developer Sandbox Updates

If your team has a large number of sandboxes it can be challenging to see only those relevant to you. Sandbox assignment can help.

Assign sandboxes to your team

Use the quick search feature to search for specific pull requests (PRs) or environments.

Quick Search in Pipelines

This is a guideline to manually setup service hooks in Azure DevOps (ADO)

Manual setup of CI jobs and Pipeline webhooks in Azure DevOps

Automate PR descriptions with LLMs! Analyse changes & create clear, informative summaries fast, aiding reviewers.

Pull Request Description Generation

Guidance on creating your first Gearset Pipeline, promoting first features and all the other Pipeline workflow related configurations

Getting started with Gearset Pipelines

There is a minimum set of permissions needed by the member (or members) of the team who are setting up the CI jobs and Pipelines

Pipeline setup - minimum permissions needed to set up Gearset pipelines

Our advice around which metadata types to include when setting up your automated pipeline.

Pipeline setup - what metadata types should I include for Gearset pipelines?

Key considerations when deciding whether to refresh all environments prior to setting up Gearset Pipelines

Pipeline setup - implications of in-progress work

Claudia McPhail

George Marino

Valerio Chang

Find out about actions we recommend teams take before setting up a new Pipeline

Prerequisites for Pipeline setup

A step-by-step guide on how to publish your first team message in pipelines.

How to add a message to your pipeline

Learn how to install and use the Gearset extension to track Salesforce changes and send them to a feature branch.

How to Install and Use the Gearset Extension

Syncing environments in Gearset Pipelines (also referred to as 'static environments') via the use of 'Create sync PR' feature

Keep your Pipeline environment branches in sync

The Gearset Pipeline allows you to configure it to automatically create Sync PRs after each release to Prod. Find out where to find the setting and how it works.

Automatically create Sync PRs after Prod release

This article describes how to add/remove changes or fixes to a feature that is already in your Pipeline.

Edit or fix a user story in progress in pipelines

How to roll back a change deployed from your Gearset Pipeline

Rollback with Gearset Pipelines

How to configure your pipeline in Gearset to update the status of a Jira ticket.

Updating a Jira ticket's status in pipelines

How to link a Azure work item ticket to Gearset pipelines. Allowing for automatic updates.

Updating an Azure work item's status in pipelines

There are a few methods to roll back changes in pipelines, and this article explains how to use git commands to help achieve that.

Deployment rollback in pipelines (using the command line)

A short explanation on the difference between two-way and three-way merges in git.

Two-way and three-way merges explained

Information on how Gearset retrieves Jira issues according to their status

Understanding Jira statuses in Workflows and their role in Gearset Pipelines

Getting your features back-propagated through your Pipeline into the lower, long-lived (static), environments and Dev Sandboxes.

Org syncing with Pipelines

The process to follow when needing to fix a Gearset Pipeline

How to realign/fix an out of sync Pipeline

Simplified explanation of why additional commits may appear in your pull requests.

Pull request showing unexpected differences

The process to follow when needing to adjust the metadata filter of your Pipelines' Continuous Integration (CI) jobs

Adding previously missing metadata types into Gearset Pipelines

Understand when it's right for your team to have this option enabled or disabled within your Gearset Pipeline

When to enable/disable back propagation in developer sandboxes?

Code coverage per feature is displayed in pipelines, aiding pre-merge quality gates

Code coverage in pipelines

Digitsec & Gearset pipelines

CI job and Pipeline webhooks

Quick Deploy

Explained - when you can use "Manually resolve" option when it becomes available on your failed PR validation in "Deployment pipelines" page

"Manually resolve" option on Pull Request in the Pipelines UI

Common Pipeline related questions from our users

Additional pipeline questions

What steps to consider when refreshing a sandbox that is part of a pipeline

How do I refresh a Sandbox in my pipeline?

How to configure notifications about your pipeline and any associated PRs

Setting up notifications in pipelines

This article explains how to find your deployment, validation and unit testing history on "View job performance" page

How to see your deployment and validation times in a Gearset Pipelines

Find out how ServiceNow integration works with Releases in Gearset Pipelines

Getting started with ServiceNow and Gearset releases

Guidelines on the initial setup for ServiceNow. Find out what's required within ServiceNow, and how to integrate it in Gearset.

Integrating with ServiceNow

Leverage the DORA metrics to track your DevOps performance in Pipelines

Measuring your DevOps performance

A complete guide to automating actions in your pipeline with Continuous Delivery Rules.

Getting started with Continuous Delivery Rules in Gearset Pipelines

How to start tracking your change failure rate and mean time to restore in Gearset's DevOps performance dashboard

Change failure management - Bug fixes

How Gearset handles concurrent promotion requests in Pipelines

Queuing PRs for Promotion

Find out more about adding Apex tests to be executed in your pipeline for a specific Pull Request

Specifying Apex Tests for a Pull Request in Gearset Pipelines

Samuel Crossland

Ryan Nebuda

Patrick Boyd

Further information about Gearset Pipelines and how to manage them

Gearset Pipeline management

Resolving merge conflicts

Precision conflict resolution

Using Gearset's conflict replay to help you resolve conflicts you've seen before

Using conflict replay to quickly resolve conflicts in Pipelines

Sam Wilson

Find out how to handle and resolve merge conflicts in Gearset Pipelines 

Merge conflict resolution in Pipelines

Guidelines on how to create team-shared pipelines, or how to convert an existing user-owned pipeline into a team-shared one.

Team-shared pipelines

How to convert a user owned pipeline to a team-shared pipeline. This includes converting user-owned org and CI jobs to team-shared ones.

Converting a Pipeline to a Team-shared Pipeline

How to Use Developer Sandbox Groups to Organize Your Pipelines

Grouping Developer Sandboxes in Pipelines

Expected behavior for using individual versus team-shared Git credentials during automated pipeline use.

Which Git credentials are used for which actions in Pipelines?

Expected Behavior for Individual versus Team-Shared Jira Credentials in Automated Pipeline Use

Which Jira credentials are used for which actions in Pipelines?

Find out about Team-shared Pipelines and how to implement them

Team-shared Pipelines

How to create and use release functionality within pipelines to group together stories, validate and release them in a single block

Releases in Pipelines

If you use GitHub Milestones and Labels, you can use these with Gearset Pipelines to create your releases.

How to organize your releases with GitHub Milestones

This guide explains how bundles differ from legacy release workflows and what steps you might need to take to support bundles.

Introducing Bundles: A new foundation for future release workflows in Pipelines

Features within releases will no longer be back propagated individually, instead they will be back propagated within a single bundle PR for each environment.

Back propagation of releases as a single unit - what you need to know

Jack Parkinson

Find out about Releases in Gearset Pipelines

Find out more about attaching deployment steps to your Pipelines feature work

Pre and Post Deployment Steps in Gearset Pipelines

Discover how you can create a collection of commonly required Pre and Post-Deployment Steps to re-use for your feature pull requests

Deployment Steps Library in Gearset Pipelines

Some tips to help with common Markdown content formatting options.

Markdown Help for Deployment Step Descriptions

How to activate Flows when deploying to Production orgs using Pipelines

Flow Activation - Automatically Deploying Flows as Active with Deployment Steps

Find out about how to track your pre-deployment and post-deployment steps from within your Pipeline

Pre and Post Deployment Steps

Layered modules let you manage your core Salesforce setup consistently across multiple orgs.

What are layered modules?

This article describes the process of using the setup wizard for layered modules to convert the structure of an empty repository.

Modularizing a repository using the setup wizard for layered modules

This article explains how to restructure your existing repository to use the layered modules with a Pipeline

Restructuring an existing repository to use layered modules

How to protect your core module, which contains shared metadata, from unintended changes by regional or org-specific teams.

Protecting Your Core module with Code Owners and RBAC in Gearset

When using Gearset's layered modules, the comparison process provides a clear view of how your core interacts with org-specific metadata.

Comparing with Layered Modules in Gearset

Seeding your layered modules as part of a multi-org pipeline

Populating your layered modules

How to set up Pipelines to validate and deploy to multiple Production orgs using Gearsets' layered modules

Setting up a Pipeline to use layered modules

After setting up your layered module Pipeline, you're ready to make your first deployments.

Promoting a change through a Pipeline using layered modules

This article is for the teams who wants to test layered modules with their own metadata

How to trial layered modules

How to update your sandboxes when using a layered module pipeline

Developer Sandbox Updates in Layered Module Pipelines

Sravani Bhattiprolu

Find out about using Layered Modules to deploy to multiple orgs 

Layered Module Pipelines

Understanding how Gearset Gitflow branching model works

An introduction to Gearset Gitflow branching model

A step-by-step guide on how to create your first Gearset Gitflow Pipeline using our setup wizard.