Add api for "ok to preview" comments

Author: patrick91

app/github.py

@@ -5,14 +5,14 @@
 from .config import GITHUB_TOKEN
 from .release import ReleaseInfo
 
-SIGNATURE = "<!-- action-check: release-file -->"
+SIGNATURE_TEMPLATE = "<!-- action-check: {slug} -->"
 API_BASE = "https://api.github.com"
 
 
-def is_release_check_comment(comment: dict) -> bool:
+def has_signature(comment: dict, slug: str) -> bool:
     return (
         comment["user"]["login"] in ["github-actions[bot]", "botberry"]
-        and SIGNATURE in comment["body"]
+        and SIGNATURE_TEMPLATE.format(slug) in comment["body"]
     )
 
 
@@ -44,11 +44,11 @@ def get_labels(pr_number) -> typing.List[dict]:
     return response.json()
 
 
-def add_or_edit_comment(pr_number: int, comment: str):
+def add_or_edit_comment(pr_number: int, comment: str, slug: str):
     current_comments = get_comments(pr_number)
 
     previous_comment = next(
-        (comment for comment in current_comments if is_release_check_comment(comment)),
+        (comment for comment in current_comments if has_signature(comment, slug)),
         None,
     )
 
@@ -58,7 +58,7 @@ def add_or_edit_comment(pr_number: int, comment: str):
     response = method(
         url,
         headers={"Authorization": f"token {GITHUB_TOKEN}"},
-        json={"body": comment + SIGNATURE},
+        json={"body": comment + SIGNATURE_TEMPLATE.format(slug)},
     )
 
     response.raise_for_status()

app/schema.py

@@ -1,11 +1,16 @@
-import typing
 from enum import Enum
+from typing import List, Optional
 
 import strawberry
 
 from .github import add_or_edit_comment, update_labels
 from .release import ReleaseInfo
-from .templates import INVALID_RELEASE_FILE, MISSING_RELEASE_FILE, RELEASE_FILE_ADDED
+from .templates import (
+    INVALID_RELEASE_FILE,
+    MISSING_RELEASE_FILE,
+    OK_TO_PREVIEW,
+    RELEASE_FILE_ADDED,
+)
 
 
 @strawberry.type
@@ -26,11 +31,34 @@ class ReleaseFileStatus(Enum):
 class AddReleaseFileCommentInput:
     pr_number: int
     status: ReleaseFileStatus
-    release_info: typing.Optional[ReleaseInfo] = None
+    release_info: Optional[ReleaseInfo] = None
+
+
+@strawberry.input
+class AddOkToPreviewCommentInput:
+    pr_number: int
+    paths: List[str]
 
 
 @strawberry.type
 class Mutation:
+    @strawberry.mutation
+    def add_ok_to_preview_comment(self, input: AddOkToPreviewCommentInput) -> str:
+        paths = [
+            p.replace(".md", "").replace("docs/", "").replace("README", "")
+            for p in input.paths
+        ]
+        links = [
+            f"https://strawberry.rocks/docs/pr/{input.pr_number}/{path}"
+            for path in paths
+        ]
+
+        comment = OK_TO_PREVIEW.format(links=links)
+
+        add_or_edit_comment(input.pr_number, comment, slug="ok-to-preview")
+
+        return "ok"
+
     @strawberry.mutation
     def add_release_file_comment(self, input: AddReleaseFileCommentInput) -> str:
         """Adds a comment about the release file to a PR."""
@@ -46,7 +74,7 @@ def add_release_file_comment(self, input: AddReleaseFileCommentInput) -> str:
         if input.release_info:
             comment = comment.format(changelog_preview=input.release_info.changelog)
 
-        add_or_edit_comment(input.pr_number, comment)
+        add_or_edit_comment(input.pr_number, comment, slug="release-file")
         update_labels(input.pr_number, input.release_info)
 
         return "ok"

app/templates.py

@@ -1,3 +1,9 @@
+OK_TO_PREVIEW = """\
+Hi 👋 You can find a preview of the docs here:
+
+{links}
+"""
+
 MISSING_RELEASE_FILE = """\
 Hi, thanks for contributing to Strawberry 🍓!