Skip to main content
All CollectionsAutomationPipelinesGetting started with Gearset Pipelines
Feature branch format - optional Pipeline setting
Feature branch format - optional Pipeline setting

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

Mateusz Kochanowicz avatar
Written by Mateusz Kochanowicz
Updated over a month ago

Gearset teams using Pipeline can select a template for all feature branches that are created through the Dev Sandbox New feature flow.
​
This flow can be accessed when you click on any of the Dev Sandboxes within the Pipeline (from the Pipelines UI page), and then select this button: .

This option allows users working with Pipelines to assign either Jira or Azure ticket when creating a new feature in Gearset Pipelines.

Minimum requirements:
​- To use this feature in Gearset Pipelines, you need to have either Jira or AzureDevOps connection added to Source control and services page.


​Note: This Pipeline setting will be disabled by default in the tooltip if users don't have either Jira or Azure ticket tracking in their pipeline.

In which case it is expected to see this notification when configuring your pipeline settings: "You must enable Jira or Azure work items to select a branch name template.".

How to enable it in Gearset Pipelines

To enable a template for naming convention of your feature branches, select the cog iconon the Pipelines UI page > Edit pipeline details > Feature branch format.

Currently, there are only two templates to choose from:

  • [id]

  • [id]/[story_name]
    ​

Feature overview with Jira

Configuring your Pipeline setting for feature branch format to [id] would pre-fill the name for the feature branch as per the Jira's "Project key".

Project keys are unique keys to identify a Jira project (more information in Jira documentation).

Example 1 - [id]

On below example I'm creating a new feature with the use of [id] template for feature branch names.


Project key is defined here in Jira under Project settings > Project key, as on below example.

Example 2 - [id] / [story_name]

While configuring Pipeline to use template [id]/[story_name] makes the feature branch naming convention to follow the project key / ticket name in Jira.

Example of a feature branch template in Gearset:

And this is how the ticket looks in Jira:

Feature overview with Azure work items

Similarly as with Jira tickets, depending on whether your Pipeline settings for feature branch format is set to [id] or [id]/[story_name], the template name for the feature branch will either be Azure work item's ID or ID / Title.


Quick demo of how both options work for Azure work items when pre-filling feature branch's name in Pipelines UI:

And in Azure DevOps, this is where the ID and Title details are being pulled from:

Did this answer your question?