All Collections
Git Integration
Connect a GitHub Repository to a Jira Project
Connect a GitHub Repository to a Jira Project

Want to know how to connect your JIRA project to a GitHub? This page describes how to use the Behave Pro wizard to connect a GitHub repo.

Alan Parkinson avatar
Written by Alan Parkinson
Updated over a week ago


This guide assumes that you or your Jira administrator have installed the Behave Pro app in GitHub and have authorized the connection of Behave Pro to GitHub. If you haven’t, you can follow the steps of this guide to install and authorize Behave Pro (Note: Link to other guides)

Behave Pro project settings

To access the Behave Pro Git integration settings you need to access the settings menu for the Jira project you want to work with. From there, locate ‘Behave Pro’ and click on it:

Once you click on the Behave Pro you will be taken to the Behave Pro settings for your project that is currently disabled.

Click on the slide toggle opposite User Story discovery with BDD toggle to start the Behave Pro project configuration process.

To begin the process of setting up your repository, click on the ‘Get Started’ button

Then you will see the page titled Select Your Workflow. Classic workflow, where feature files are stored with Jira and can be pulled via hooks into your automation architecture. Git workflow, where feature files are stored within a GitHub repository of your choosing, and any changes you make in the repository are reflected within Behave Pro. Click Select within the git section.

Next, you will need to select your Github Organisation and choose the repository you wish to connect. Before clicking continue, you will need to select your teams branching strategy, this is an important decision as Behave Pro will work with the repository in different ways depending on this setting.

If you and your team create branches for every user story or bug and open Pull Requests to perform code reviews before merging then select Feature branching. If changes are committed directly to the main/master/trunk branch without creating any branches then select Trunk based.

If you are still unsure about your team's strategy please read this article to help you decide which strategy works for you.

Once you have configured these settings and click Continue you will be presented with the branch settings page.

In the branch list, you should select your base or default branch for the repository. This is usually called master, main, or trunk for Feature Branching or Trunk based development projects. For a repository using a Gitflow strategy then the branch will be called develop instead of master.

Behave Pro needs to understand where feature files should be stored within your repository and this is specified in the Feature file directory. This directory should already exist within the repository and any feature files stored at this location will be automatically imported into Behave Pro. You can leave it empty to point to the root directory.

At the end of this installation flow, you will be redirected to the Requirements page of your project where you can begin to create feature files, write scenarios, and see them appear in your Github project.

Please note, when feature branching is enabled the requirements page will be in read-only mode, and you won't be able to create, edit, or delete scenarios and features on this page. Changes can only be made from Jira Issues because the issue keys are used to identify feature branches.


Did this answer your question?