All Collections
Getting Started
Installing and Configuring Behave Pro
Installing and Configuring Behave Pro

Enabling Behave Pro for a Jira project

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

You will need Jira administrator privileges to enable Behave Pro in a Jira project. This guide assumes you have already installed Behave Pro through the Atlassian Marketplace, this guide will apply to evaluation licences as well as paid ones.

Firstly, within the Jira project which you want to add Behave Pro functionality to, move to the, 'project settings' section.

Assuming that Behave Pro has been installed from the Atlassian Marketplace you will see at the bottom of the left-hand navigation panel that there will be a Behave Pro section. This may not been in the exact same location as you may have more apps installed in your Jira instance.

After clicking the toggle in the top-right corner of the Behave Pro configuration page you will be taken through the initial setup of Behave Pro. Click the, 'Get Started' button when you are ready to begin.

The first part of the configuration is to select your workflow, we will discuss the differences between the two in more detail further into the, "Getting Started" section. A git project will automatically add the feature files you generate through Behave Pro to your git repository while a Classic project is where you will export them and manually place them where you want them to be, this causes some differences in workflow. We will do our best to cover them all in these Getting Started section however if we miss anything feel free to open a chat with us and ask. We will be covering a git configuration as selecting a classic workflow would end the setup as there are no further choices to be made.

Within a git project, you will now need to select the organisation, this will show a drop-down menu or all the git organisations that you have connected to your Jira; if you are not seeing your organisation please follow this guide to add it. After this, there is another drop-down for your repository, this will show all of the repositories that are connected to the organisation you selected, select the one for this project.

You will also see the choices for branching strategy, this will also create differences in workflow later. Trunk based should be used if all commits are made directly to the base branch; feature branching should be used if features are created on seperate branches that are then merged into the main branch. Select the one that matches your development teams workflow; the following screen will be the same with either branching strategies.

If you are using a trunk based branching strategy you may need to give us permissions to make changes to the base branch

You will now need to configure your branch settings, for the 'Branch' drop-down list, you will want to select your base branch regardless of which branching strategy you chose in the previous step. Under this is the feature file directory, this is where Behave Pro will output your feature files to as well as where it will read your feature files from to display in your living documentation. It's worth noting that when reading your files it will be looking in the feature file directory on the base branch specified, so you will need to merge your feature files in the base branch to use the living documentation feature.

After this you should be configured and ready to begin.

Did this answer your question?