Git Sync for Jira

User Guide & Documentation

Git Sync for Jira helps your team get more out of Jira.

Getting Started

1. Install the app
A Jira administrator installs Git Sync for Jira from the Atlassian Marketplace (Apps, Explore more apps). It runs on Atlassian Forge: there is nothing to host or configure outside Jira.
2. Find it in Jira
Open a Jira project and select Git Sync in the project's navigation (under Apps).
3. Open your Jira project and select the Git Sync tab
4. In Conventions, set the branch prefix for each issue type, the separator and the max slug length, then save
5. In Branch name, enter an issue key and select Generate, then copy the branch name shown
6. Link branches, commits and pull requests to issues as remote issue links, or pick a Jira field that holds Git URLs in Conventions
7. Open Git references to see every reference per issue, and Activity report to filter by status, sort by any column and export CSV

Demo video

Data shown: a fictional demo project.

Walkthrough

Open Git Sync from the project. The Branch name tab builds names from your saved template.
Open Git Sync from the project. The Branch name tab builds names from your saved template.
Type an issue key, for example DEMO-12, and select Generate.
Type an issue key, for example DEMO-12, and select Generate.
The branch name follows your convention: prefix by issue type, key and a short slug. Select it and copy.
The branch name follows your convention: prefix by issue type, key and a short slug. Select it and copy.
Conventions: set the template, separator, slug length and a prefix for each issue type, once per project.
Conventions: set the template, separator, slug length and a prefix for each issue type, once per project.
Git references: see the branches and commits linked to each issue, filtered by status.
Git references: see the branches and commits linked to each issue, filtered by status.
Activity report: issues, assignees and linked branches in one sortable table.
Activity report: issues, assignees and linked branches in one sortable table.
Export the report as CSV text, ready to paste into a spreadsheet.
Export the report as CSV text, ready to paste into a spreadsheet.

Overview

Naming conventions live in a settings panel: a branch prefix map by issue type, a separator character and a max slug length, all persisted per project in Forge storage. When you generate a branch name for an issue, it is built from that saved template every time, shown ready to select and copy, so the format never drifts between developers or projects. The reporting side lists every issue in the project next to the Git references parsed from a designated Jira field and remote issue links, filterable by status. A per-project activity report (issue key, status, assignee, linked branch count, last updated) is built from live Jira REST v3 reads, sortable by any column, and exportable as CSV. The current release reads from Jira and Forge storage only: no external GitHub connection, no external servers, no external egress. That keeps your settings and issue data inside Atlassian's trust boundary while still giving you reliable, transparent Git visibility on every issue.

Key Features

Branch names that always match your format

Every branch name is generated from the per-project template you saved in settings, prefix, separator and slug length included, so developers never have to manually fix an inconsistent branch name again.

See every branch, commit and PR in one report

Git references parsed from your Jira field and issue links show up in one sortable table per project, so you can confirm work is actually linked instead of trusting a panel that just says connected.

Filter, sort and export your Git activity

Filter the issue list by status, sort the activity report by any column, and export it as CSV for standups, audits or sharing outside Jira without rebuilding the data by hand.

Frequently Asked Questions

Does Git Sync need to connect to GitHub or another Git host?

No, the current release reads only from Jira REST v3 and Forge storage. Branch, commit and PR references are parsed from a designated Jira field and remote issue links, with no external connection required.

Can I customize the branch naming format per project?

Yes, the settings panel lets you set a branch prefix per issue type, a separator character and a max slug length, saved per project. The generator always applies this saved format.

Can I export the Git activity report?

Yes, the per-project activity report (issue key, status, assignee, linked branch count, last updated) can be exported as CSV directly from the table.

Where do the branch, commit and PR links come from?

They are parsed from a designated Jira field on each issue plus the issue's remote links, then shown alongside every issue in the project list, filterable by status.

Is my naming configuration stored outside Jira?

No, per-project naming conventions are stored in Forge KVS, which lives inside Atlassian's infrastructure alongside your Jira data.

Permissions and data

The app reads Jira data with the permissions of the person using it, and only:

Everything runs on Atlassian Forge and no data leaves Atlassian. Details in the privacy policy.

Support

For questions, issues, or feature requests:

© 2026 Ivars Apps (Luis Ivars Unipessoal Lda). All rights reserved.