fix: 修复合并插件配置后没有删除对应分支和关闭议题的问题

Author: he0119

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/lang/zh-CN/
 
 ## [Unreleased]
 
+### Fixed
+
+- 修复合并插件配置后没有删除对应分支和关闭议题的问题
+
 ## [4.1.2] - 2024-12-02
 
 ### Fixed

src/plugins/github/depends/__init__.py

@@ -10,7 +10,7 @@
 )
 from nonebot.params import Depends
 
-from src.plugins.github.constants import REMOVE_LABEL
+from src.plugins.github.constants import CONFIG_LABEL, REMOVE_LABEL
 from src.plugins.github.models import GithubHandler, IssueHandler, RepoInfo
 from src.plugins.github.typing import IssuesEvent, LabelsItems, PullRequestEvent
 from src.plugins.github.utils import run_shell_command
@@ -19,18 +19,18 @@
 from .utils import extract_issue_number_from_ref
 
 
-def bypass_git():
+async def bypass_git():
     """绕过检查"""
     # https://github.blog/2022-04-18-highlights-from-git-2-36/#stricter-repository-ownership-checks
     run_shell_command(["git", "config", "--global", "safe.directory", "*"])
 
 
-def install_pre_commit_hooks():
+async def install_pre_commit_hooks():
     """安装 pre-commit 钩子"""
     run_shell_command(["pre-commit", "install", "--install-hooks"])
 
 
-def get_labels(event: PullRequestEvent | IssuesEvent):
+async def get_labels(event: PullRequestEvent | IssuesEvent):
     """获取议题或拉取请求的标签"""
     if isinstance(event, PullRequestClosed | PullRequestReviewSubmitted):
         labels = event.payload.pull_request.labels
@@ -39,7 +39,7 @@ def get_labels(event: PullRequestEvent | IssuesEvent):
     return labels
 
 
-def get_labels_name(labels: LabelsItems = Depends(get_labels)) -> list[str]:
+async def get_labels_name(labels: LabelsItems = Depends(get_labels)) -> list[str]:
     """通过标签获取名称"""
     label_names: list[str] = []
     if not labels:
@@ -51,12 +51,12 @@ def get_labels_name(labels: LabelsItems = Depends(get_labels)) -> list[str]:
     return label_names
 
 
-def get_issue_title(event: IssuesEvent):
+async def get_issue_title(event: IssuesEvent):
     """获取议题标题"""
     return event.payload.issue.title
 
 
-def get_repo_info(event: PullRequestEvent | IssuesEvent) -> RepoInfo:
+async def get_repo_info(event: PullRequestEvent | IssuesEvent) -> RepoInfo:
     """获取仓库信息"""
     repo = event.payload.repository
     return RepoInfo(owner=repo.owner.login, repo=repo.name)
@@ -72,19 +72,19 @@ async def get_installation_id(
     return installation.id
 
 
-def get_issue_number(event: IssuesEvent) -> int:
+async def get_issue_number(event: IssuesEvent) -> int:
     """获取议题编号"""
     return event.payload.issue.number
 
 
-def get_related_issue_number(event: PullRequestClosed) -> int | None:
+async def get_related_issue_number(event: PullRequestClosed) -> int | None:
     """获取 PR 相关联的议题号"""
     ref = event.payload.pull_request.head.ref
     related_issue_number = extract_issue_number_from_ref(ref)
     return related_issue_number
 
 
-def is_bot_triggered_workflow(event: IssuesEvent):
+async def is_bot_triggered_workflow(event: IssuesEvent):
     """是否是机器人触发的工作流"""
     if (
         isinstance(event, IssueCommentCreated)
@@ -102,7 +102,9 @@ def is_bot_triggered_workflow(event: IssuesEvent):
     return False
 
 
-def get_github_handler(bot: GitHubBot, repo_info: RepoInfo = Depends(get_repo_info)):
+async def get_github_handler(
+    bot: GitHubBot, repo_info: RepoInfo = Depends(get_repo_info)
+):
     """获取 GitHub 处理器"""
     return GithubHandler(bot=bot, repo_info=repo_info)
 
@@ -136,7 +138,7 @@ async def get_related_issue_handler(
     )
 
 
-def get_type_by_labels_name(
+async def get_type_by_labels_name(
     labels: list[str] = Depends(get_labels_name),
 ) -> PublishType | None:
     """通过标签的名称获取类型"""
@@ -146,6 +148,44 @@ def get_type_by_labels_name(
     return None
 
 
-def is_remove_workflow(labels: list[str] = Depends(get_labels_name)) -> bool:
+async def is_publish_workflow(
+    labels: list[str] = Depends(get_labels_name),
+    publish_type: PublishType | None = Depends(get_type_by_labels_name),
+) -> bool:
+    """是否是发布工作流
+
+    通过标签判断
+    仅包含发布相关标签，不包含 remove/config 标签
+    """
+    if publish_type is None or REMOVE_LABEL in labels or CONFIG_LABEL in labels:
+        logger.debug("与发布无关，已跳过")
+        return False
+
+    return True
+
+
+async def is_remove_workflow(
+    labels: list[str] = Depends(get_labels_name),
+    publish_type: PublishType | None = Depends(get_type_by_labels_name),
+) -> bool:
     """是否是 Remove 工作流"""
+    if publish_type is None:
+        logger.debug("与发布无关，已跳过")
+        return False
+
     return REMOVE_LABEL in labels
+
+
+async def is_config_workflow(
+    labels: list[str] = Depends(get_labels_name),
+    publish_type: PublishType | None = Depends(get_type_by_labels_name),
+) -> bool:
+    """是否是 Config 工作流
+
+    仅支持插件发布
+    """
+    if publish_type != PublishType.PLUGIN:
+        logger.debug("与插件无关，已跳过")
+        return False
+
+    return CONFIG_LABEL in labels

src/plugins/github/depends/utils.py

@@ -1,6 +1,5 @@
 import re
 
-from src.plugins.github.constants import REMOVE_LABEL
 from src.plugins.github.typing import PullRequestLabels
 from src.providers.validation.models import PublishType
 
@@ -21,13 +20,3 @@ def get_type_by_labels(labels: PullRequestLabels) -> PublishType | None:
             if label.name == type.value:
                 return type
     return None
-
-
-def is_remove_by_pull_request_labels(labels: PullRequestLabels) -> bool:
-    """通过拉取请求的标签确认是否是删除类型"""
-    for label in labels:
-        if isinstance(label, str):
-            continue
-        if label.name == REMOVE_LABEL:
-            return True
-    return False

src/plugins/github/plugins/config/__init__.py

@@ -16,8 +16,8 @@
     get_github_handler,
     get_installation_id,
     get_issue_handler,
-    get_type_by_labels_name,
     is_bot_triggered_workflow,
+    is_config_workflow,
 )
 from src.plugins.github.models import IssueHandler
 from src.plugins.github.models.github import GithubHandler
@@ -26,9 +26,7 @@
     ensure_issue_plugin_test_button,
     ensure_issue_plugin_test_button_in_progress,
 )
-from src.plugins.github.plugins.remove.depends import check_labels
 from src.plugins.github.typing import IssuesEvent
-from src.providers.validation.models import PublishType
 
 from .constants import BRANCH_NAME_PREFIX, COMMIT_MESSAGE_PREFIX, RESULTS_BRANCH
 from .utils import (
@@ -39,20 +37,16 @@
 
 async def check_rule(
     event: IssuesEvent,
-    is_config: bool = check_labels(CONFIG_LABEL),
     is_bot: bool = Depends(is_bot_triggered_workflow),
-    publish_type: PublishType = Depends(get_type_by_labels_name),
+    is_config: bool = Depends(is_config_workflow),
 ) -> bool:
     if is_bot:
         logger.info("机器人触发的工作流，已跳过")
         return False
-    if publish_type != PublishType.PLUGIN:
-        logger.info("与插件无关，已跳过")
-        return False
     if event.payload.issue.pull_request:
         logger.info("评论在拉取请求下，已跳过")
         return False
-    if is_config is False:
+    if not is_config:
         logger.info("非配置工作流，已跳过")
         return False
     return True
@@ -131,7 +125,7 @@ async def handle_remove_check(
 
 async def review_submitted_rule(
     event: PullRequestReviewSubmitted,
-    is_config: bool = check_labels(CONFIG_LABEL),
+    is_config: bool = Depends(is_config_workflow),
 ) -> bool:
     if not is_config:
         logger.info("拉取请求与配置无关，已跳过")

src/plugins/github/plugins/publish/__init__.py

@@ -16,20 +16,18 @@
 
 from src.plugins.github.constants import (
     BRANCH_NAME_PREFIX,
-    CONFIG_LABEL,
-    REMOVE_LABEL,
     TITLE_MAX_LENGTH,
 )
 from src.plugins.github.depends import (
     bypass_git,
     get_github_handler,
     get_installation_id,
     get_issue_handler,
-    get_labels_name,
     get_related_issue_handler,
     get_related_issue_number,
     install_pre_commit_hooks,
     is_bot_triggered_workflow,
+    is_publish_workflow,
 )
 from src.plugins.github.models import GithubHandler, IssueHandler
 from src.providers.validation.models import PublishType, ValidationDict
@@ -52,35 +50,18 @@
 )
 
 
-async def publish_related_rule(
-    labels: list[str] = Depends(get_labels_name),
-    publish_type: PublishType = Depends(get_type_by_labels_name),
-) -> bool:
-    """确保与发布相关
-
-    通过标签判断
-    仅包含发布相关标签，不包含 remove/config 标签
-    """
-    for label in labels:
-        if label == REMOVE_LABEL:
-            return False
-        if label == CONFIG_LABEL:
-            return False
-    return True
-
-
 async def check_rule(
     event: IssuesOpened | IssuesReopened | IssuesEdited | IssueCommentCreated,
-    publish_type: PublishType | None = Depends(get_type_by_labels_name),
     is_bot: bool = Depends(is_bot_triggered_workflow),
+    is_publish: bool = Depends(is_publish_workflow),
 ) -> bool:
     if is_bot:
         logger.info("机器人触发的工作流，已跳过")
         return False
     if event.payload.issue.pull_request:
         logger.info("评论在拉取请求下，已跳过")
         return False
-    if not publish_type:
+    if not is_publish:
         logger.info("议题与发布无关，已跳过")
         return False
 
@@ -89,7 +70,7 @@ async def check_rule(
 
 publish_check_matcher = on_type(
     (IssuesOpened, IssuesReopened, IssuesEdited, IssueCommentCreated),
-    rule=Rule(check_rule, publish_related_rule),
+    rule=Rule(check_rule),
 )
 
 
@@ -201,10 +182,10 @@ async def handle_pull_request_and_update_issue(
 
 
 async def pr_close_rule(
-    publish_type: PublishType | None = Depends(get_type_by_labels_name),
+    is_publish: bool = Depends(is_publish_workflow),
     related_issue_number: int | None = Depends(get_related_issue_number),
 ) -> bool:
-    if publish_type is None:
+    if not is_publish:
         logger.info("拉取请求与发布无关，已跳过")
         return False
 
@@ -215,9 +196,7 @@ async def pr_close_rule(
     return True
 
 
-pr_close_matcher = on_type(
-    PullRequestClosed, rule=Rule(pr_close_rule, publish_related_rule)
-)
+pr_close_matcher = on_type(PullRequestClosed, rule=Rule(pr_close_rule))
 
 
 @pr_close_matcher.handle(
@@ -240,9 +219,9 @@ async def handle_pr_close(
 
 async def review_submitted_rule(
     event: PullRequestReviewSubmitted,
-    publish_type: PublishType | None = Depends(get_type_by_labels_name),
+    is_publish: bool = Depends(is_publish_workflow),
 ) -> bool:
-    if publish_type is None:
+    if not is_publish:
         logger.info("拉取请求与发布无关，已跳过")
         return False
     if event.payload.review.author_association not in ["OWNER", "MEMBER"]:
@@ -256,7 +235,7 @@ async def review_submitted_rule(
 
 
 auto_merge_matcher = on_type(
-    PullRequestReviewSubmitted, rule=Rule(review_submitted_rule, publish_related_rule)
+    PullRequestReviewSubmitted, rule=Rule(review_submitted_rule)
 )
 
 

src/plugins/github/plugins/remove/__init__.py

@@ -21,21 +21,21 @@
     get_type_by_labels_name,
     install_pre_commit_hooks,
     is_bot_triggered_workflow,
+    is_remove_workflow,
 )
 from src.plugins.github.models import IssueHandler
 from src.plugins.github.models.github import GithubHandler
 from src.plugins.github.typing import IssuesEvent
 from src.providers.validation.models import PublishType
 
-from .constants import BRANCH_NAME_PREFIX, REMOVE_LABEL
-from .depends import check_labels
+from .constants import BRANCH_NAME_PREFIX
 from .render import render_comment, render_error
 from .utils import process_pull_reqeusts
 from .validation import validate_author_info
 
 
 async def pr_close_rule(
-    is_remove: bool = check_labels(REMOVE_LABEL),
+    is_remove: bool = Depends(is_remove_workflow),
     related_issue_number: int | None = Depends(get_related_issue_number),
 ) -> bool:
     if not is_remove:
@@ -51,7 +51,7 @@ async def pr_close_rule(
 
 async def check_rule(
     event: IssuesEvent,
-    is_remove: bool = check_labels(REMOVE_LABEL),
+    is_remove: bool = Depends(is_remove_workflow),
     is_bot: bool = Depends(is_bot_triggered_workflow),
 ) -> bool:
     if is_bot:
@@ -60,7 +60,7 @@ async def check_rule(
     if event.payload.issue.pull_request:
         logger.info("评论在拉取请求下，已跳过")
         return False
-    if is_remove is False:
+    if not is_remove:
         logger.info("非删除工作流，已跳过")
         return False
     return True
@@ -122,7 +122,7 @@ async def handle_remove_check(
 
 async def review_submitted_rule(
     event: PullRequestReviewSubmitted,
-    is_remove: bool = check_labels(REMOVE_LABEL),
+    is_remove: bool = Depends(is_remove_workflow),
 ) -> bool:
     if not is_remove:
         logger.info("拉取请求与删除无关，已跳过")