GitLab Listener Documentation

Installation

GitLab Listener is available for any Jira Cloud installation. Just log in to your Jira account, go the GitLab Listener Atlassian Marketplace page, and click the button to install the plugin.

Configuration

Once GitLab Listener is installed, find it in the list of your installed apps in Jira and press the "Configure" button.

Now you need to link your GitLab repositories to Jira. In order to do that, provide your Personal Accees Token that you can find or create in your GitLab account. The minimum permission scope needed for the token is 'read_api'.

GitLab Listener will automatically detect all Git repositories that your GitLab account has access to and display them on the configuration page. You can configure which of the repositories you want to link to Jira, and see when GitLab Listener last checked them for new data.

If you need to update the credentials used to link GitLab Listener to your Git repositories, you can always return to GitLab Listener configuration page and click "Re-configure GitLab integration".

Using GitLab Listener

As soon as the configuration is finished, you are ready to use GitLab Listener. Just navigate to any issue in your Jira project, and you will see GitLab menu option on the right.

Click on it, an it will display all the Git commits, branches, and merge requests linked to your Jira issue. Linking is done via issue keys (e.g. PROJ-123). That means you will need to include issue keys in your commit and merge request titles, and branch names in order for them to be picked up by GitLab Listener.

Further information

Feel free to contact us via our feedback form if you have any questions.