Skip to content

Files

Latest commit

ashikkumar23ashikkumar23
Update README
Apr 29, 2025
98585e3 · Apr 29, 2025

History

History
98 lines (73 loc) · 3.39 KB

README.md

File metadata and controls

98 lines (73 loc) · 3.39 KB

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.
  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

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 to login to Jira.
  3. The workflow uses the Atlassian Jira Create Action 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

🛡 License

This project is licensed under the MIT 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.