Git Integration for Jira Cloud Documentation

Contact support
GitKraken Status  

Create branch

Jira administrator notes

 


 

Introduction

The Create branch feature offers Jira users the ability to create a git branch directly from the Jira issue.


For information about creating pull/merge requests from a Jira issue – see Create pull or merge request.

 

Advantages

When creating a branch from within Jira:

  • Automatically populates branch name with issue key (necessary for branch ↔ issue association) and issue summary.

  • Further – default branch naming conventions can be customized to match your development workflow. For example: ${issuetype:New Issue,new,Bug Fix,bug}/${issuekey}-${summary} generates “bug/PRJ-123-add-more-logging” (See General settings for more information).

  • Require each Jira user to provide their Personal Access Token for creating branches. This option adds some friction to creating branches/pull requests but enabling this setting will enforce the git server user permissions as well as give better attribution for the actions. See Require Personal Access Tokens for user actions (create branch/pull request) for more information.

  • Each Jira user can set a Default repository for the current Jira project. (See User settings for more information).

 

Supported

  • Full feature integrations:

    • GitHub
    • GitLab
    • Bitbucket Cloud
    • AWS CodeCommit
    • Azure DevOps
    • Microsoft Visual Studio Team Services (VSTS)
    • Microsoft Team Foundation Server (TFS)
  • Supported in the Atlassian Jira Cloud iOS, Android and MacOS.

  • Company-managed and Team-managed Jira projects supported.

  • New and old Jira Issue View supported.

 

Steps to creating a git branch in Jira

  1. PREREQUISITE Jira administrator configures a Full feature integration in the Git Integration for Jira Cloud app. See Integration Guide for more information.

  2. To access the Create branch action – do one of the following:

  3. Click Create branch in one of the panels from step 2.

  4. Select git repository.

    • Optional: designate the repository to be the default selected repository for current Jira project. To configure default repositories for more than one Jira project – use the User settings page.

    • Use the search box to look for the specific name of the repository that will be used.

  5. If a personal access token is required (and not yet provided) – follow on screen instructions to provide a personal access token with correct permissions for selected repository.

  6. Select base branch.

  7. Verify branch name is correct. Edit as desired. Note: the Jira issue key must remain in the branch name to create the branch ↔ Jira issue association.

  8. Click Create branch.

Make a commit to this branch and continue to create a pull/merge request.

After creating a branch, it is added to the Git Integration developer panel under the Branches list. The branch name does not have a commit if it is displayed in italics.

 

Video: Creating branch via Git Development panel

Right click here to open this video in a new browser tab for more viewing options.

 

Video: Creating branch from Git Source Code panel

Right click here to open this video in a new browser tab for more viewing options.

If you still have a question – reach out to our Support Desk or email us at [email protected].

Have feedback about this article? Did we miss something? Let us know!
On this page