This article will run through the steps to set up a pipeline in Gearset.
How to set up your first Gearset Pipeline
To set up a Gearset Pipeline, navigate to the side menu on the top left corner in our app, and under Continuous Delivery
select Pipelines
:
This will take you to the Deployment pipelines landing page.
Select Create a pipeline
to get started!
You'll then be taken to the pipeline setup wizard.
This page will prompt you to enter a Pipeline name, and you'll need to decide whether your pipeline will be team-shared or user-owned. Our recommendation is to use a team-shared pipeline.
Note: If you are creating a team-shared pipeline, it's critical that you have a team-shared source control connection added in Gearset. Every Gearset user using a team-shared Pipeline will also need to add their personal source control connection.
For more information, view our doc here on team-shared pipelines.
Issue Tracking
In this step, you can optionally add issue tracking to your pipeline.
Don't worry if you haven't made any decisions on issue tracking just yet; you may always add this in at a later date.
If you'd like to add issue tracking, tick Link features to user stories
and then select your issue tracker.
You'll need to connect your Jira or ADO to do this. We have guides on integrating with Jira and updating an azure work item's status in pipelines that will help you with this.
Select which format you want your feature branches to use (read more about this feature here). You may see a preview of what this format looks like underneath your selection:
Pull Requests
Lastly, we'll configure our pull requests.
Here, you may choose whether your pull requests Require a description, or Copy reviewers when promoting a PR through environments.
You may change these settings at a later date if you are unsure.
Set up your repository
In the next step, you'll be prompted to set up your repository.
This includes selecting your Git provider, repository, and the default base branch for your repository.
First, select your Git provider. You'll need to link the Git provider you're using to your Gearset account if you haven't done so already.
For guidance on how to add source control connections, follow our guide here.
Once you've connected your Git provider to your Gearset account, select the repository you'll use for this pipeline:
You may choose an already existing repository, or create one automatically with recommended settings via the pipelines wizard instead. The default behaviour is to create a new repository. However, you can choose an existing repository by selecting Change.
Once a Git provider and repository have been added, the next step is to select a Default base branch for new features.
Usually, this is Main or Master. For more information on this, check out our document on the pipelines branching model.
Populate your repository
The next step is to populate your repository. This means populating your main branch with a baseline of metadata.
At this point, you may either use Gearset's auto-detect feature to scan your org's metadata and suggest types to include, or select specific metadata types you want to populate your repository with:
If you miss a metadata type at this stage that you want to include later, it's easy to add this in. For more information, see our guide on Adding previously missing metadata types into Gearset pipelines
If you'd like to read more on our recommended practices for what to include here, feel free to read our guide on what metadata types should I include for Gearset pipelines?
Once you're happy with your filter, click Next
to proceed to the summary screen:
From here, you can review what metadata will be added to your new repository, and edit in metadata types you may have missed.
After you're happy, select Create pipeline and populate
. After you select this, the pipeline wizard will populate the repository.
Important: You won't be able to add any static environments until this process is complete!
Set up your Pipeline webhooks
After your pipeline has been created, you'll be prompted to set up your pipeline webhook.
Your pipeline can't function without a webhook, so it's crucial we set this up!
For most version control systems, we recommend creating a webhook automatically by selecting Create a webhook automatically
:
If you click off this screen or reload your page without setting up a webhook, you can always set up your webhook by selecting add a webhook for this repository here
:
Conclusion
Congratulations! You have now created your first Gearset pipeline using the pipeline wizard.
Now, you'll be prompted to create your first static environment to automatically deploy changes to an org from a long-lived branch.
For help on this, check out our guide on setting up your first CI job in Gearset.