Usage

🔧 Setup & Configuration

1. First-Time Setup

Navigate to Jira App Settings → Find "Git Info Configuration" in admin panel

Then Go to “Git for Jira“
Click "Add New Configuration"
Choose your Git provider:
- 🐙 GitHub: Personal Access Token.
- 🦊 GitLab: Access Token.
- 🔷 Azure DevOps: PAT
  
  Note the app also support create pull request and merge pull request feature, so both READ and WRITE permission is required.

2. Configure Connection

Enter the configuration name(customized), token and repos you prefer to search.

3. Repository Management

Auto-fetch: Use "Fetch My Repositories" button
Manual add: Enter owner/repo (GitHub) or project/repo (Azure DevOps)
Note that Manual add is recommended, because it will have small set of scope to search and index which have better performance, however, if you don’t want to maintain frequently as your repo count increases fast, please use Auto.
Multiple configs: Create separate configs for different environments

🎯 Using the App in Jira Issues

Now you are able to check the Git information in any Jira issue. You will find the Git information panel displayed like this:

If you don’t see this panel, you can enable it via:

📝 Commits Tab

Shows all commits mentioning this Jira issue

📦 What you'll see:
• Commit messages containing your issue key (e.g., PROJ-123)
• Author, date, and repository info
• Direct links to commits on Git platform
• Quick SHA copy button

🎯 Use case: Track all code changes for a specific issue

⚙️ Pipelines Tab

Displays CI/CD pipeline runs

🔧 What you'll see:
• Pipeline/build status (✅ Success, ❌ Failed, ⏳ Running)
• Trigger information and duration
• Branch and commit details
• Direct links to pipeline runs

🎯 Use case: Monitor build status for issue-related changes

🚀 Deployments Tab

Shows deployment history

🌍 What you'll see:
• Deployment environments (Production, Staging, etc.)
• Deployment status and timestamps
• Related commits and branches
• Deployment URLs

🎯 Use case: Track where and when changes were deployed

🌿 Branches Tab

Lists branches related to the issue

🌱 What you'll see:
• Branch names containing issue key
• Last commit date and author
• Branch protection status
• Quick navigation to branches

🎯 Use case: Find all active development branches

🔀 Pull Requests Tab

Displays linked PRs/Merge Requests

🔄 What you'll see:

PR titles and descriptions
Status (Open, Merged, Closed)
Source → Target branch flow
Direct PR links
Merge/Close actions (if supported)

🎯 Use case: Review and manage pull requests

📄 File Changes Tab

Detailed file diff view

📊 What you'll see:
• Files changed in each commit
• Line-by-line diff with +/-
• Change statistics (additions/deletions)
• File status (added, modified, deleted)

🎯 Use case: Review exact code changes

⚡ Actions Tab

Perform Git operations directly from Jira!

🌿 Create Branch

1. Select repository
2. Choose "Create Branch" action  
3. Enter: Branch name (suggested: feature/PROJ-123)
4. Select: Source branch (usually main/master)
5. Click: Execute → Branch created! ✅

🔀 Create Pull Request

1. Select repository
2. Choose "Create PR" action
3. Fill: Title, source branch, target branch
4. Add: Description (auto-filled with issue reference)
5. Click: Execute → PR created! ✅

✅ Merge Pull Request

1. Select repository with open PRs
2. Choose "Merge PR" action
3. Select: PR to merge from dropdown
4. Confirm: Merge action
5. Click: Execute → PR merged! ✅

🎮 Quick Actions Guide

For Developers:

1. 📌 See issue PROJ-123 in Jira
2. 🌿 Go to Branches tab → Create "feature/PROJ-123"
3. 💻 Code and commit (mention PROJ-123 in commit message)
4. 🔀 Go to PR tab → Create pull request
5. ⚙️ Monitor pipeline in Pipelines tab
6. 🚀 Track deployment in Deployments tab

For Managers/Testers:

1. 📊 Check Commits tab for all changes
2. 👀 Review File Changes tab for code review
3. ✅ Check Pipelines tab for build status
4. 🌍 Verify Deployments tab for release status
5. 🔍 Use PR tab to review pending changes

🔄 Refresh & Cache

Auto-cache: Data cached for 1 week for performance
Manual refresh: Click "Refresh" button in any tab
Force refresh: Hold Shift + Click Refresh (bypasses cache)

🎨 Visual Indicators

Status Badges:

✅ Success (Green): Completed successfully
⏳ Running/In Progress (Blue): Currently executing
❌ Failed (Red): Operation failed
⚠️ Pending/Queued (Yellow): Waiting to run
🔄 Unknown (Gray): Status unclear

Provider Icons:

🐙 GitHub
🦊 GitLab
🔷 Azure DevOps

🎯 Remember: The app works by searching for your Jira issue key (like PROJ-123) in Git content. Always include the issue key in branch names, commit messages, and PR titles for best results!

Happy coding! 🚀👨‍💻👩‍💻