https://github.com/ashikkumar23/jira-github-integration
This repository demonstrates a proof of concept (POC) for integrating Jira with GitHub Actions. The primary goal is to automate the creation of Jira bug tickets when specific conditions are met in GitHub, such as the addition of a bug label to an issue.
https://github.com/ashikkumar23/jira-github-integration
automation bug-tracking devops github github-actions github-labels issue-management jira-automation jira-integration poc workflow-automation
Last synced: 23 days ago
JSON representation
This repository demonstrates a proof of concept (POC) for integrating Jira with GitHub Actions. The primary goal is to automate the creation of Jira bug tickets when specific conditions are met in GitHub, such as the addition of a bug label to an issue.
- Host: GitHub
- URL: https://github.com/ashikkumar23/jira-github-integration
- Owner: ashikkumar23
- License: mit
- Created: 2025-04-25T10:13:22.000Z (28 days ago)
- Default Branch: master
- Last Pushed: 2025-04-29T06:08:58.000Z (25 days ago)
- Last Synced: 2025-04-30T15:37:12.973Z (23 days ago)
- Topics: automation, bug-tracking, devops, github, github-actions, github-labels, issue-management, jira-automation, jira-integration, poc, workflow-automation
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jira GitHub Integration
This repository demonstrates a **Proof of Concept (POC)** for integrating Jira with GitHub Actions. The primary goal is to automate the creation of Jira bug tickets whenever a GitHub issue is labeled as `bug`.
---
## 🛠 Features
- Automatically sync GitHub issues labeled as `bug` to Jira as bug tickets.
- Map issue details (e.g., title, description, reporter) directly into Jira tickets.
- Leverages **GitHub Actions** for seamless workflow automation.
- Provides a clear audit trail with links back to the original GitHub issue.
---
## 📁 Project Structure
```
jira-github-integration/
├── .github/
│ └── workflows/
│ └── jira-integration.yml # GitHub Actions workflow file
├── LICENSE # MIT License file
└── README.md # This documentation
```
---
## 🔧 Prerequisites
Before you begin, ensure you have the following:
1. **Jira Account**: Access to a Jira instance with admin rights to a project.
2. **GitHub Repository**: A repository where you have admin permissions to set up Actions.
3. **API Token**: A Jira API token for authentication. [Learn how to generate one](https://confluence.atlassian.com/cloud/api-tokens-938839638.html).
4. **GitHub Secrets**:
- `JIRA_BASE_URL`: Your Jira instance URL (e.g., `https://your-domain.atlassian.net`).
- `JIRA_USER_EMAIL`: The email address associated with your Jira account.
- `JIRA_API_TOKEN`: Your Jira API token.
---
## ⚙️ Setup Instructions
#### 1. Clone the Repository
```bash
git clone https://github.com/ashikkumar23/jira-github-integration.git
cd jira-github-integration
```
#### 2. Configure Secrets
Go to your repository's **Settings** > **Secrets and variables** > **Actions**, and add the following secrets:
- `JIRA_BASE_URL`
- `JIRA_USER_EMAIL`
- `JIRA_API_TOKEN`
#### 3. Update the Workflow File
The workflow file is located at `.github/workflows/jira-integration.yml`. Ensure the following is set:
- Replace `JGI` with your Jira project key.
- Adjust other parameters if needed.
#### 4. Test the Workflow
- Create a new issue in the repository.
- Add the `bug` label to the issue.
- Check your Jira project for a new bug ticket.
---
## 🚀 How It Works
1. When you add the `bug` label to a GitHub issue, the workflow is triggered.
2. The workflow uses the [Atlassian Jira Login Action](https://github.com/atlassian/gajira-login) to login to Jira.
3. The workflow uses the [Atlassian Jira Create Action](https://github.com/atlassian/gajira-create) to create a bug ticket in Jira.
4. The issue details (title, description, reporter, and URL) are mapped to the Jira ticket.
---
## 🌟 Limitations
- Currently supports only issues labeled as `bug`.
- Does not sync updates or status changes from Jira back to GitHub.
---
## 📖 References
- [Jira API Documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/)
- [GitHub Actions Documentation](https://docs.github.com/en/actions)
- [Atlassian Jira Login Action](https://github.com/atlassian/gajira-login)
- [Atlassian Jira Create Action](https://github.com/atlassian/gajira-create)
---
## 🛡 License
This project is licensed under the [MIT License](LICENSE).
---
## 🤝 Contributing
Contributions are welcome! Feel free to open issues or submit pull requests.
---
## 📞 Support
If you encounter any issues or have questions, please feel free to open an issue in this repository.