Merge pull request #26 from evrone-erp/feature/ERP-1756/add_title_for_link_in_description

[ERP-1756] Add title for link in description

Author: sosedov

helpers/github.py

@@ -1,29 +1,38 @@
 import logging
 import re
 import sys
-from typing import Optional
+from typing import Dict, Optional
 
 from github.PullRequest import PullRequest
 
 TASK_KEY_PATTERN = re.compile(r"[^[]*\[([^]]*)\]")  # noqa
+TASK_LINK_TITLE_TEMPLATE = (
+    "[[{task_key}] {task_title}](https://tracker.yandex.ru/{task_key})"
+)
 logger = logging.getLogger(__name__)
 
 
 def _prepare_description(
     *,
-    task_keys: list[str],
+    tasks: Dict,
     pr: PullRequest,
 ) -> Optional[str]:
     """
     Update the existing PR description with links to the task keys.
     Args:
-      task_keys: List of the Yandex tracker tasks from action.
+      tasks: Dict with Yandex Tracker task number as key and task data as value.
       pr: GitHub PullRequest object.
     Return:
       Description in string format if exists or None.
     """
     body = pr.body
-    links = [f"https://tracker.yandex.ru/{task}" for task in filter(None, task_keys)]
+    links = [
+        TASK_LINK_TITLE_TEMPLATE.format(
+            task_key=task_key,
+            task_title=task_data.get("summary", ""),
+        )
+        for task_key, task_data in tasks.items()
+    ]
 
     task_links = ""
     for link in links:
@@ -60,16 +69,16 @@ def get_pr_commits(
 
 def set_pr_body(
     *,
-    task_keys: list[str],
+    tasks: Dict,
     pr: PullRequest,
 ) -> None:
     """
     Set PR description with a link to tracker task.
     Args:
-      task_keys: list of Yandex tracker task keys.
+      tasks: Dict with Yandex Tracker task number as key and task data as value.
       pr: GitHub PullRequest object.
     """
-    description = _prepare_description(task_keys=task_keys, pr=pr)
+    description = _prepare_description(tasks=tasks, pr=pr)
     if description:
         pr.edit(body=description)
 

helpers/yandex.py

@@ -1,6 +1,7 @@
 import logging
 import sys
 from http import HTTPStatus
+from typing import Dict
 
 import requests
 from github.PullRequest import PullRequest
@@ -42,7 +43,7 @@ def task_exists(
     is_yandex_cloud_org: bool,
     tasks: list[str],
     token: str,
-) -> list[str]:
+) -> Dict:
     """
     Get Yandex API with task keys. If a task does not exist, remove from a list.
     Args:
@@ -76,8 +77,7 @@ def task_exists(
             )
             continue
         existing_tasks[task] = response.json()
-
-    return [k for (k, v) in existing_tasks.items() if "errors" not in v]
+    return {k: v for (k, v) in existing_tasks.items() if "errors" not in v}
 
 
 def _get_all_transitions(

index.json

@@ -1,6 +1,7 @@
 import json
 import logging
 import sys
+from typing import Dict
 
 from environs import Env
 from github import Github
@@ -58,7 +59,7 @@
     iam_token = get_iam_token(YANDEX_OAUTH2_TOKEN)
 
     if any(task_keys):
-        existing_tasks = task_exists(
+        existing_tasks: Dict = task_exists(
             org_id=YANDEX_ORG_ID,
             is_yandex_cloud_org=IS_YANDEX_CLOUD_ORG,
             tasks=task_keys,
@@ -67,7 +68,7 @@
     else:
         logger.warning("[SKIPPED] No tasks found!")
         sys.exit(0)
-    set_pr_body(task_keys=existing_tasks, pr=pr)
+    set_pr_body(tasks=existing_tasks, pr=pr)
 
     if TARGET_STATUS:
         target_status = TARGET_STATUS
@@ -90,7 +91,7 @@
             org_id=YANDEX_ORG_ID,
             is_yandex_cloud_org=IS_YANDEX_CLOUD_ORG,
             pr=pr,
-            task_keys=existing_tasks,
+            task_keys=list(existing_tasks),
             target_status=target_status,
             token=iam_token,
         )