Skip to content

Commit

Permalink
fix(workflow): fix closed tickets to project board
Browse files Browse the repository at this point in the history 
ZenHub doesn't have closed pipeline, so we need to iterate through all
closed issues in the GitHub repo.

Longhorn 9155

Signed-off-by: Derek Su <[email protected]>
  • Loading branch information
@derekbit @innobead
derekbit authored and innobead committed Aug 7, 2024
1 parent 47914ac commit ae5cabe
Showing 1 changed file with 127 additions and 22 deletions.
149 changes: 127 additions & 22 deletions .github/workflows/migrate_zenhub_board_to_github_project.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import os
import jq
import sys
import time


GITHUB_API_URL = "https://api.github.com"
Expand Down Expand Up @@ -131,11 +132,18 @@ def get_github_project_info(github_token, github_org, github_project):
}

response = requests.post(GITHUB_GRAPHQL_URL, headers=headers, json=payload)
print(f"GitHub Project Info: {response.json()}")
if response.status_code == 200:
# fine project by title
for project in response.json().get("data").get("organization").get("projectsV2").get("nodes"):
if project.get("title") == github_project:
return project
nodes = response.json().get("data").get("organization").get("projectsV2").get("nodes")
print(f"Nodes: {nodes}")

for node in nodes:
print(f"Node: {node}")
print(f"Title: {node.get('title')}")
print(f"GitHub Project: {github_project}")
if node.get("title") == github_project:
return node
else:
response.raise_for_status()

Expand Down Expand Up @@ -212,6 +220,51 @@ def set_item_estimate(github_token, project_id, item_id, field_id, value):
response.raise_for_status()


def get_github_issues(github_token, github_org, github_repo, state):
url = f"https://api.github.com/repos/{github_org}/{github_repo}/issues"
headers = {
"Authorization": f"token {github_token}",
"Accept": "application/vnd.github.v3+json"
}
params = {
"state": "closed",
"per_page": 100,
"page": 1
}

all_issues = []
while True:
response = requests.get(url, headers=headers, params=params)
if response.status_code != 200:
raise Exception(f"Error fetching issues: {response.status_code} {response.text}")

issues = response.json()
if not issues:
break

all_issues.extend(issues)
params["page"] += 1

return all_issues


def get_zenhub_issue_info(zenhub_token, github_repo_id, issue_number):
url = f"https://api.zenhub.com/p1/repositories/{github_repo_id}/issues/{issue_number}"
headers = {
"X-Authentication-Token": zenhub_token,
"Accept": "application/json"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
return response.json()
elif response.status_code == 403:
print("Rate limit exceeded. Sleeping for 1 minute")
else:
response.raise_for_status()


def check_zenhub_pipelins_github_project_status_match(board, status):
zenhub_pipelines = [pipeline['name'] for pipeline in board['pipelines']]
github_project_statuses = list(status.keys())
Expand All @@ -220,43 +273,55 @@ def check_zenhub_pipelins_github_project_status_match(board, status):
raise Exception(f"Pipeline '{pipeline}' not found in GitHub Project statuses")


def migrate_tickets(github_org, github_repo, github_project):
github_token = os.getenv("GITHUB_TOKEN")
zenhub_token = os.getenv("ZENHUB_TOKEN")
def add_closed_issues_to_github_project(github_token, zenhub_token, github_org, github_repo, project_id, status, status_node_id, estimate_node_id):
github_repo_id = get_github_repo_id(github_token, github_org, github_repo)
issues = get_github_issues(github_token, github_org, github_repo, "closed")

# Get the GitHub Project details
project = get_github_project_info(github_token, github_org, github_project)
print(f"GitHub Project Details: {project}")
project_number = project.get("number")
project_id = project.get("id")
status_node_id, status = get_github_project_status(github_token, github_org, github_repo, project_number)
print(f"GitHub Project Details: number={project_number}, id={project_id}, status node_id={status_node_id}, status={status}")
print(f"Found {len(issues)} closed issues in the GitHub repo")

estimate_node_id = get_github_project_estimate(github_token, github_org, github_repo, project_number)
print(f"GitHub Project Details: number={project_number}, id={project_id}, estimate node_id={estimate_node_id}")
for issue in issues:
print(f"Processing closed issue: {issue['number']}")

# Get the ZenHub board details
github_repo_id = get_github_repo_id(github_token, github_org, github_repo)
print(f"GitHub Repo ID: {github_repo_id}")
board = get_zenhub_board(zenhub_token, github_repo_id)
# Exclude PRs to the project
if 'pull_request' not in issue:
result = add_github_project_item(github_token, project_id, issue['node_id'])
print(f"Added issue: result={result}")

item_id = result['data']['addProjectV2ItemById']['item']['id']
move_item_to_status(github_token,
project_id, item_id,
status_node_id,
status['Closed'])

zenhub_issue = get_zenhub_issue_info(zenhub_token, github_repo_id, issue['number'])
print(f"ZenHub Issue Info: {zenhub_issue}")

# check if estimate is exist
if 'estimate' in zenhub_issue:
print(f"Setting estimate: {zenhub_issue['estimate'].get('value')} for issue: {issue['number']}")
set_item_estimate(github_token,
project_id, item_id,
estimate_node_id, zenhub_issue['estimate'].get('value'))
# Sleep for 2 seconds to avoid rate limiting
time.sleep(2)

# Check pipelines of the ZenHub board and status of the GitHub Project are matching using for loop
check_zenhub_pipelins_github_project_status_match(board, status)

def add_zenhub_pipelines_to_github_project(github_token, github_org, github_repo, project_id, board, status, status_node_id, estimate_node_id):
for pipeline in board['pipelines']:
# Iterating through each pipeline, which are corresponding to the GitHub Project statuses (columns)
column_name = pipeline['name']

# Iterating through each ticket in the pipeline,
# and creating a corresponding GitHub issue

for issue in pipeline['issues']:
print("Issue: ", issue)
print(f"Processing issue: {issue['issue_number']} in pipeline: {column_name}")
issue_info = get_github_issue(github_token, github_org, github_repo,
issue['issue_number'])

result = add_github_project_item(github_token,
project_id, issue_info['node_id'])
print(f"Added issue: result={result}")
item_id = result['data']['addProjectV2ItemById']['item']['id']
move_item_to_status(github_token,
project_id, item_id,
Expand All @@ -269,6 +334,46 @@ def migrate_tickets(github_org, github_repo, github_project):
project_id, item_id,
estimate_node_id, issue['estimate'].get('value'))

def migrate_tickets(github_org, github_repo, github_project):
github_token = os.getenv("GITHUB_TOKEN")
zenhub_token = os.getenv("ZENHUB_TOKEN")

# Get the GitHub Project details
project = get_github_project_info(github_token, github_org, github_project)
print(f"GitHub Project Details: {project}")
project_number = project.get("number")
project_id = project.get("id")
status_node_id, status = get_github_project_status(github_token, github_org, github_repo, project_number)
print(f"GitHub Project Details: number={project_number}, id={project_id}, status node_id={status_node_id}, status={status}")

estimate_node_id = get_github_project_estimate(github_token, github_org, github_repo, project_number)
print(f"GitHub Project Details: number={project_number}, id={project_id}, estimate node_id={estimate_node_id}")

# Get the ZenHub board details
github_repo_id = get_github_repo_id(github_token, github_org, github_repo)
print(f"GitHub Repo ID: {github_repo_id}")
board = get_zenhub_board(zenhub_token, github_repo_id)
for pipeline in board['pipelines']:
print(f"Pipeline: {pipeline}")

# Check pipelines of the ZenHub board and status of the GitHub Project are matching using for loop
check_zenhub_pipelins_github_project_status_match(board, status)

# Add ZenHub pipelines to the GitHub Project Statuses
add_zenhub_pipelines_to_github_project(github_token,
github_org, github_repo,
project_id,
board,
status, status_node_id,
estimate_node_id)

# ZenHub doesn't have closed pipeline, so we need to iterate through all closed issues in the GitHub repo.
add_closed_issues_to_github_project(github_token, zenhub_token,
github_org, github_repo,
project_id,
status, status_node_id,
estimate_node_id)


if __name__ == "__main__":
if len(sys.argv) < 4:
Expand Down

0 comments on commit ae5cabe

Please sign in to comment.