Flask API를 사용하여 JIRA 티켓 생성 자동화: GitHub Webhook 통합 가이드

Python 및 Flask를 사용하여 GitHub 문제 댓글에서 JIRA 티켓을 자동으로 생성하여 워크플로를 간소화하세요

? 소개

DevOps의 세계에 오신 것을 환영합니다! 오늘 우리는 원활한 통합을 위해 Jira와 GitHub를 연결하는 흥미로운 프로젝트에 대해 알아보겠습니다. 이 프로젝트의 목표는 GitHub 문제 댓글에서 직접 Jira 티켓 생성을 자동화하여 개발자의 시간을 절약하고 수동 작업을 줄이는 것입니다.

이 프로젝트를 진행하는 방법은 다음과 같습니다.

• Flask API 설정: Flask 애플리케이션을 호스팅하기 위해 t2.micro Ubuntu 기반 EC2 인스턴스를 시작합니다.
• Jira 구성: Jira에서 프로젝트를 만들고 해당 API를 티켓 생성에 사용하겠습니다.
• API 통합: Flask 앱에 Jira API 토큰을 제공하면 앱이 Jira와 상호 작용할 수 있습니다.

모든 것이 설정되면 Flask 앱이 GitHub용 웹훅 API 역할을 합니다. 개발자가 GitHub 문제에 대해 /jira에 댓글을 달 때마다 프로그램은 Jira 대시보드에 표시되는 해당 Jira 티켓을 자동으로 생성합니다. 흥미롭죠? 시작해 보세요!

---

? 전제조건

프로젝트를 시작하기 전에 다음 사항을 준비하세요.

• GitHub 및 Jira 계정: 통합을 구성하려면 두 플랫폼 모두에서 활성 계정이 필요합니다.
• Flask 설치: Python 환경에 Flask가 설정되어 있는지 확인하세요. 그렇지 않은 경우 다음을 사용하여 설치할 수 있습니다.

pip install flask

• EC2 및 Flask에 대한 기본 이해: EC2 인스턴스 설정 및 간단한 Flask 애플리케이션 생성에 익숙하면 원활하게 진행하는 데 도움이 됩니다.

이러한 전제 조건이 충족되면 이 프로젝트를 시작할 준비가 모두 완료되었습니다!

---

? EC2 인스턴스 및 Flask 애플리케이션 설정

Flask 애플리케이션을 호스팅하기 위한 EC2 인스턴스를 생성하고 설정하여 프로젝트를 시작하겠습니다. 다음 단계를 따르세요.

1단계: EC2 인스턴스 생성

• AWS EC2 대시보드로 이동하여 새로운 t2.micro Ubuntu 기반 인스턴스를 생성합니다.
• 인스턴스 이름을 jira-github-integration으로 지정하세요.

• SSH 접속을 위한 키 쌍 파일을 다운로드하세요.
• Flask 애플리케이션에 액세스하려면 보안 그룹에서 포트 5000을 엽니다.

2단계: 인스턴스에 SSH 접속
다운로드한 키 쌍 파일을 사용하여 인스턴스에 SSH로 연결합니다.

pip install flask

3단계: Python 환경 설정
Python과 Flask를 설치하려면 다음 명령을 실행하세요.

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

이렇게 하면 프로젝트에 필요한 모든 종속성이 설정됩니다.

4단계: Flask 애플리케이션 생성

• 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

파일에 다음 콘텐츠를 추가하세요.

nano github_jira.py

---

? Atlassian API 토큰 생성

github_jira.py 스크립트를 실행하기 전에 두 가지 중요한 정보가 필요합니다.

• Atlassian API 토큰
• Atlassian 도메인 이름

Atlassian API 토큰 생성 단계:

• Atlassian 계정에 로그인하세요:
• Atlassian을 방문하여 자격 증명으로 로그인하세요.

계정 설정으로 이동하세요:

• 오른쪽 상단에 있는 프로필 사진이나 아바타를 클릭하세요.
• 드롭다운 메뉴에서 계정 설정을 선택하세요.
• 보안 탭으로 이동:
• 계정 설정 페이지에서 보안 탭을 클릭하세요.
• API 토큰 섹션에서 API 토큰 생성을 클릭하세요.

새 API 토큰 생성:

• 설명(예: GitHub Jira 통합)을 제공하고 메시지가 표시되면 토큰 만료 날짜를 설정합니다.
• 만들기를 클릭하면 API 토큰이 생성됩니다.

API 토큰 복사:

• 복사 버튼을 클릭해 토큰을 복사하세요.
• github_jira.py 스크립트의 API_TOKEN 변수에 토큰을 붙여넣습니다.

 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)

Atlassian 도메인 추가:
을 교체하세요. Atlassian 도메인 이름을 사용하여 url 변수에 추가하세요. 예를 들어 Jira 대시보드 URL이 https://yourworkspace.atlassian.net인 경우 yourworkspace.atlassian.net을 도메인으로 사용하세요.

---

? github_jira.py 스크립트에서 필수 필드 구성

스크립트를 실행하기 전에 Jira 계정과 통합이 원활하게 작동하도록 github_jira.py 파일에서 몇 가지 중요한 필드를 업데이트해야 합니다.

1. HTTP 기본 인증(이메일 주소)
HTTPBasicAuth의 첫 번째 매개변수를 Jira 계정에 연결된 이메일 주소로 바꿉니다.

API_TOKEN = "<Your-Generated-API-Token>"

2. 프로젝트 키

• 프로젝트 키는 티켓이 생성될 Jira 프로젝트를 고유하게 식별합니다.
• 프로젝트 키를 찾으려면:
• Jira 대시보드로 이동하세요.
• 프로젝트 탭에서 티켓이 생성될 프로젝트를 찾으세요.
• 프로젝트 키는 간단한 괄호(()) 안에 표시됩니다. 예를 들어 Project ABC(SCRUM) 프로젝트에서 키는 SCRUM입니다.

스크립트 필드 아래의 "키" 필드를 바꿉니다.

pip install flask

3. 문제 유형 ID

• 문제 유형 ID는 문제 유형(예: 버그, 스토리, 작업)에 대한 고유 식별자입니다.
• 문제 ID를 찾으려면:
• Jira 대시보드에서 오른쪽 상단에 있는 세 개의 점을 클릭하고 사용자 정의 필드 관리를 선택하세요.

• 프로젝트 설정의 왼쪽 메뉴에서 이슈 유형으로 이동하세요.
• 스토리나 사용하려는 이슈 유형을 클릭하세요.
• 브라우저에서 URL을 확인하세요. URL 끝에는 숫자 값(예: 10005)이 있습니다. 이것이 귀하의 문제 유형 ID입니다.

스크립트의 issuetype 아래에 있는 "id" 필드를 교체하세요.

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

스크립트에서 업데이트된 필드의 예:

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

마지막 단계: 스크립트 실행
이러한 필드가 업데이트되면 다음을 사용하여 스크립트를 실행하세요.

nano github_jira.py

이제 스크립트가 완전히 구성되었으며 GitHub 댓글을 Jira 티켓 생성과 통합할 준비가 되었습니다!

---

? 웹훅을 추가하여 통합 완료

이제 스크립트가 준비되었으므로 마지막 단계는 GitHub 저장소에 웹훅을 구성하는 것입니다. 이 웹훅은 특정 이벤트(이 경우 주석 발행)를 수신하고 Flask 애플리케이션을 트리거합니다.

웹훅 추가 단계:

• GitHub 저장소로 이동:
• 이 프로젝트를 테스트하려는 GitHub 저장소를 엽니다. 저장소 설정 액세스:
• 저장소 메뉴에 있는 설정 탭을 클릭하세요.
• 왼쪽 탐색 모음의 '코드 및 자동화' 섹션에서 웹후크를 선택하세요.

새 웹훅 추가:

• 웹훅 추가 버튼을 클릭하세요.
• 웹훅 구성:
• 페이로드 URL: Flask 애플리케이션의 URL을 입력하세요. 여기에는 EC2 인스턴스의 퍼블릭 DNS와 Flask 엔드포인트에 대한 경로가 포함되어야 합니다.

pip install flask

• 콘텐츠 유형:
  드롭다운 메뉴에서 애플리케이션/json을 선택합니다.

• 트리거:
  "개별 이벤트 선택" 옵션을 선택하세요.
  이슈 댓글에만 체크하세요.

웹훅 저장:

• 웹훅 추가 버튼을 클릭하여 설정을 저장하세요.

통합 테스트

• GitHub에서 문제 만들기:
• 저장소의 문제 탭으로 이동하세요.
• 새호를 클릭하고 제목과 설명을 입력한 후 저장하세요.
• 문제에 대한 의견:
• 생성된 이슈를 열고 /jira로 댓글을 추가하세요.

마법 관찰:

• 웹후크가 Flask 서버에 POST 요청을 실행하고 보냅니다.
• Flask 애플리케이션은 요청을 처리하고 Jira API를 사용하여 Jira 티켓을 생성합니다.

Jira 대시보드에서 확인:

• Jira 대시보드를 열고 스크립트에 지정된 프로젝트로 이동하세요.
• GitHub 문제 댓글에 해당하는 새로 생성된 티켓이 표시됩니다.

---

? 결론

축하합니다! ? GitHub와 Jira를 통합하는 실습 프로젝트를 성공적으로 완료했습니다. Flask 애플리케이션을 중개자로 활용하여 GitHub 문제 댓글에서 직접 Jira 티켓을 생성하는 프로세스를 자동화했습니다.

이 프로젝트에서 다룬 내용은 다음과 같습니다.

• Flask 앱을 ​​호스팅하기 위한 EC2 인스턴스 설정
• Jira API와 상호작용하도록 Flask 앱을 ​​구성합니다.
• 워크플로를 트리거하기 위한 GitHub 웹훅 생성 및 추가.
• GitHub 댓글에서 Jira 티켓이 원활하게 생성되는 모습을 관찰합니다.

이 통합은 수동 작업을 줄이고 중요한 작업이 누락되지 않도록 보장하여 개발자와 프로젝트 관리자 간의 공동 작업을 단순화합니다. DevOps 워크플로에서 자동화가 어떻게 생산성을 향상할 수 있는지 보여주는 실제적인 시연입니다.

이 기반을 바탕으로 자유롭게 통합을 맞춤화하거나 Jira에서 GitHub Pull Request 추적을 자동화하거나 다른 도구를 워크플로에 통합하는 등 추가 사용 사례를 탐색해 보세요.

이 프로젝트가 유익하고 흥미로웠기를 바랍니다. ? 더 많은 정보를 제공하는 블로그를 원하시면 Hashnode, X(Twitter) 및 LinkedIn에서 저를 팔로우하세요.

코딩과 자동화를 즐겨보세요! ?

위 내용은 Flask API를 사용하여 JIRA 티켓 생성 자동화: GitHub Webhook 통합 가이드의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!