Automating JIRA Ticket Creation with a Flask API: A GitHub Webhook Integration Guide

Streamline your workflow by automatically generating JIRA tickets from GitHub issue comments using Python and Flask

? Introduction

Welcome to the world of DevOps! Today, we are diving into an exciting project that bridges Jira and GitHub for seamless integration. The goal of this project is to automate the creation of Jira tickets directly from GitHub issue comments, saving time and reducing manual effort for developers.

Here’s how we’ll tackle this project:

• Set up a Flask API: We’ll launch a t2.micro Ubuntu-based EC2 instance to host our Flask application.
• Configure Jira: We’ll create a project on Jira and use its API for ticket creation.
• Integrate APIs: By providing a Jira API token to our Flask app, we’ll enable it to interact with Jira.

Once everything is set up, our Flask app will act as a webhook API for GitHub. Anytime a developer comments /jira on a GitHub issue, the program will automatically create a corresponding Jira ticket, visible on the Jira dashboard. Exciting, right? Let’s get started!

---

? Pre-requisites

Before diving into the project, make sure you have the following ready:

• GitHub and Jira Accounts: You’ll need active accounts on both platforms to configure the integration.
• Flask Installed: Ensure Flask is set up in your Python environment. If not, you can install it using:

pip install flask

• Basic Understanding of EC2 and Flask: Familiarity with setting up an EC2 instance and creating simple Flask applications will help you follow along smoothly.

With these prerequisites in place, you're all set to kickstart this project!

---

? Setting Up the EC2 Instance and Flask Application

Let’s begin the project by creating and setting up an EC2 instance for hosting our Flask application. Follow these steps:

Step 1: Create the EC2 Instance

• Navigate to the AWS EC2 Dashboard and create a new t2.micro Ubuntu-based instance.
• Name the instance jira-github-integration.

• Download the key-pair file for SSH access.
• Open port 5000 in the security group to access the flask application.

Step 2: SSH into the Instance
Use the downloaded key-pair file to SSH into the instance:

pip install flask

Step 3: Set Up Python Environment
Run the following commands to install Python and Flask:

ssh -i your-key.pem ubuntu@<instance-public-ip>
</instance-public-ip>

This will set up all the necessary dependencies for the project.

Step 4: Create the Flask Application

• Create a new file named github_jira.py:

sudo apt update  
sudo apt install python3-pip python3-venv  
python3 -m venv myvenv  
source myvenv/bin/activate  # Activate the virtual environment  
pip3 install flask          # Install Flask in the virtual environment

Add the following content to the file:

nano github_jira.py

---

? Generating an Atlassian API Token

Before running the github_jira.py script, we need two critical pieces of information:

• Atlassian API Token
• Your Atlassian Domain Name

Steps to Generate the Atlassian API Token:

• Log in to Your Atlassian Account:
• Visit Atlassian and log in with your credentials.

Navigate to Account Settings:

• Click on your profile picture or avatar in the top-right corner.
• Select Account settings from the dropdown menu.
• Go to the Security Tab:
• In the Account settings page, click on the Security tab.
• Under the API tokens section, click on Create API token.

Create a New API Token:

• Provide a description (e.g., GitHub Jira Integration) and set an expiry date for the token if prompted.
• Click Create and your API token will be generated.

Copy the API Token:

• Click the Copy button to copy the token.
• Paste the token into the API_TOKEN variable in your github_jira.py script:

 import requests
 from requests.auth import HTTPBasicAuth
 import json
 from flask import Flask, request

 app = Flask(__name__)

 # Define a route that handles POST requests
 @app.route('/createJira', methods=['POST'])
 def createJira():
     # The comment's body field in the GitHub payload
     comment_data = request.json.get("comment", {})
     comment_body = comment_data.get("body", "")

     # Check if the body field of the comment is "/jira"
     if comment_body == "/jira":
         print("Condition met. Proceeding with POST request...")

         # Jira API details
         url = "https://<your-atlassian-domain>/rest/api/3/issue"
         API_TOKEN = "<your_api_token>"
         auth = HTTPBasicAuth("<your_email_addresss_connected_to_the_account>", API_TOKEN)

         headers = {
             "Accept": "application/json",
             "Content-Type": "application/json"
         }

         payload = json.dumps({
             "fields": {
                 "description": {
                     "content": [
                         {
                             "content": [
                                 {
                                     "text": "Order entry fails when selecting supplier.",
                                     "type": "text"
                                 }
                             ],
                             "type": "paragraph"
                         }
                     ],
                     "type": "doc",
                     "version": 1
                 },
                 "project": {
                     "key": "<your_key>"
                 },
                 "issuetype": {
                     "id": "<your_issue_id>"
                 },
                 "summary": "Main order flow broken",
             },
             "update": {}
         })

         # POST request to create an issue in Jira
         response = requests.post(url, data=payload, headers=headers, auth=auth)
         print("POST request response:", response.status_code, response.text)

         # Return the response back
         return json.dumps(json.loads(response.text), sort_keys=True, indent=4, separators=(",", ": "))
     else:
         print("No matching comment found. POST request will not be made.")
         return json.dumps({"error": "No matching comment found. POST request was not made."}, sort_keys=True, indent=4, separators=(",", ": "))

 if __name__ == '__main__':
     app.run(host='0.0.0.0', port=5000)
</your_issue_id></your_key></your_email_addresss_connected_to_the_account></your_api_token></your-atlassian-domain>

Add Your Atlassian Domain:
Replace in the url variable with your Atlassian domain name. For example, if your Jira dashboard URL is https://yourworkspace.atlassian.net, use yourworkspace.atlassian.net as the domain.

---

? Configuring Required Fields in the github_jira.py Script

Before running the script, you need to update a few important fields in the github_jira.py file to ensure the integration works seamlessly with your Jira account.

1. HTTP Basic Authentication (Email Address)
Replace the first parameter in the HTTPBasicAuth with the email address linked to your Jira account.

API_TOKEN = "<your-generated-api-token>"
</your-generated-api-token>

2. Project Key

• The Project Key uniquely identifies the Jira project where the tickets will be created.
• To find your project key:
• Go to the Jira Dashboard.
• Under the Projects tab, locate the project where tickets will be created.
• The project key is displayed in simple brackets (()). For example, in the project Project ABC (SCRUM), the key is SCRUM.

Replace the "key" field under fields in the script:

pip install flask

3. Issue Type ID

• The issue type ID is a unique identifier for the type of issue (e.g., Bug, Story, Task).
• To find the issue ID:
• In your Jira dashboard, click the three dots in the top-right corner and select Manage Custom Fields.

• In the Project Settings, navigate to Issue Types from the left-hand menu.
• Click on Story or the issue type you want to use.
• Look at the URL in your browser. At the end of the URL, you’ll find a numeric value (e.g., 10005). This is your issue type ID.

Replace the "id" field under issuetype in the script:

ssh -i your-key.pem ubuntu@<instance-public-ip>
</instance-public-ip>

Example of Updated Fields in the Script:

sudo apt update  
sudo apt install python3-pip python3-venv  
python3 -m venv myvenv  
source myvenv/bin/activate  # Activate the virtual environment  
pip3 install flask          # Install Flask in the virtual environment

Final Step: Run the Script
Once these fields are updated, run the script using:

nano github_jira.py

Your script is now fully configured and ready to integrate GitHub comments with Jira ticket creation!

---

? Adding the Webhook to Complete the Integration

Now that our script is ready, the final step is to configure a webhook in your GitHub repository. This webhook will listen for specific events (in this case, issue comments) and trigger the Flask application.

Steps to Add the Webhook:

• Navigate to the GitHub Repository:
• Open the GitHub repository where you want to test this project. Access Repository Settings:
• Click on the Settings tab located in the repository menu.
• In the left-hand navigation bar, select Webhooks under the "Code and automation" section.

Add a New Webhook:

• Click on the Add webhook button.
• Configure the Webhook:
• Payload URL: Enter the URL of your Flask application. This should include your EC2 instance's public DNS and the route for the Flask endpoint:

pip install flask

• Content Type:
  Select application/json from the dropdown menu.

• Triggers:
  Select the option "Let me select individual events".
  Check the box for Issue comments only.

Save the Webhook:

• Click the Add Webhook button to save your settings.

Testing the Integration

• Create an Issue on GitHub:
• Navigate to the Issues tab of your repository.
• Click on New Issue, provide a title and description, and save it.
• Comment on the Issue:
• Open the created issue and add a comment with /jira.

Observe the Magic:

• The webhook will trigger and send a POST request to the Flask server.
• The Flask application will process the request and create a Jira ticket using the Jira API.

Verify on the Jira Dashboard:

• Open your Jira dashboard and navigate to the project specified in your script.
• You should see a newly created ticket corresponding to the GitHub issue comment.

---

? Conclusion

Congratulations! ? You've successfully completed a hands-on project integrating GitHub and Jira. By leveraging a Flask application as an intermediary, we automated the process of creating Jira tickets directly from GitHub issue comments.

In this project, we covered:

• Setting up an EC2 instance to host a Flask app.
• Configuring the Flask app to interact with the Jira API.
• Creating and adding a GitHub webhook to trigger the workflow.
• Observing the seamless creation of Jira tickets from GitHub comments.

This integration simplifies collaboration between developers and project managers by reducing manual effort and ensuring that important tasks don't slip through the cracks. It’s a practical demonstration of how automation can enhance productivity in a DevOps workflow.

Feel free to build upon this foundation to customize the integration further or explore additional use cases, such as automating GitHub Pull Request tracking in Jira or integrating other tools into your workflow.

We hope you found this project informative and engaging. ? For more informative blog, Follow me on Hashnode, X(Twitter) and LinkedIn.

Happy coding and automating! ?

The above is the detailed content of Automating JIRA Ticket Creation with a Flask API: A GitHub Webhook Integration Guide. For more information, please follow other related articles on the PHP Chinese website!