Class BotCommentBuilder

ci/scripts/github/github_commenter.py:36–139

class BotCommentBuilder:
    ALLOWLIST_USERS = {"driazati", "gigiblender", "areusch"}

    def __init__(self, github: GitHubRepo, data: dict[str, Any]):
        self.github = github
        self.pr_number = data["number"]
        self.comment_data = data["comments"]["nodes"]
        self.author = data["author"]["login"]

    def find_bot_comment(self) -> dict[str, Any] | None:
        """
        Return the existing bot comment or None if it does not exist
        """
        for comment in self.comment_data:
            logging.info(f"Checking comment {comment}")
            if (
                comment["author"]["login"] == "github-actions"
                and BOT_COMMENT_START in comment["body"]
            ):
                logging.info("Found existing comment")
                return comment
        logging.info("No existing comment found")
        return None

    def find_existing_body(self) -> dict[str, str]:
        """
        Find existing dynamic bullet point items
        """
        existing_comment = self.find_bot_comment()
        if existing_comment is None:
            logging.info("No existing comment while searching for body items")
            return {}

        matches = re.findall(
            r"<!--bot-comment-([a-z][a-z-]+)-start-->([\S\s]*?)<!--bot-comment-([a-z-]+)-end-->",
            existing_comment["body"],
            flags=re.MULTILINE,
        )
        logging.info(f"Fetch body item matches: {matches}")

        items = {}
        for start, text, end in matches:
            if start != end:
                raise RuntimeError(
                    f"Malformed comment found: {start} marker did not have matching end, found instead {end}"
                )
            items[start] = text.strip().lstrip("* ")

        logging.info(f"Found body items: {items}")
        return items

    def _post_comment(self, body_items: dict[str, str]):
        comment = BOT_COMMENT_START + "\n\n" + WELCOME_TEXT + "\n\n"
        for key, content in body_items.items():
            line = self.start_key(key) + "\n * " + content.strip() + self.end_key(key)
            logging.info(f"Adding line {line}")
            comment += line
        comment += "\n\n<sub>Generated by [tvm-bot](https://github.com/apache/tvm/blob/main/ci/README.md#github-actions)</sub>"