/help command

open_pr.py

@@ -19,6 +19,10 @@ This PR enables Space CI on your Space. **Gradio Space CI is a tool to create ep
   - If trusted author => ephemeral Space is configured with variables, secrets and hardware.
   - If not a trusted author => ephemeral Space is started without configuration.
   - Space owners are trusted by default. Additional "trusted authors" can be configuration manually.
+- Support Slash commands : 
+    - `/help` to check the full documentation
+    - `/trust_pr` to temporarily trust a pr and configure it with the appropriate hardware and secrets.
+    - `/untrust_pr` to force a pr to reset to default hardware.
 
 ### ⚠️ Before merging:
 

src/gradio_space_ci/webhook.py

@@ -447,7 +447,7 @@ def notify_pr(
     space_id: str,
     pr_num: int,
     action: Literal[
-        "created_not_configured", "created_and_configured", "updated", "deleted", "trusted_pr", "untrusted_pr"
+        "created_not_configured", "created_and_configured", "updated", "deleted", "trusted_pr", "untrusted_pr", "help"
     ],
 ) -> None:
     ci_space_id = _get_ci_space_id(space_id=space_id, pr_num=pr_num)
@@ -463,6 +463,8 @@ def notify_pr(
         comment = NOTIFICATION_TEMPLATE_TRUSTED_PR.format(ci_space_id=ci_space_id)
     elif action == "untrusted_pr":
         comment = NOTIFICATION_TEMPLATE_UNTRUSTED_PR.format(ci_space_id=ci_space_id)
+    elif action == "help":
+        comment = NOTIFICATION_TEMPLATE_HELP
     else:
         raise ValueError(f"Status {action} not handled.")
 
@@ -501,7 +503,9 @@ def handle_command(space_id: str, payload: WebhookPayload) -> None:
     pr_num = payload.discussion.num
     details = get_discussion_details(repo_id=space_id, repo_type="space", discussion_num=pr_num)
     event_author = details.events[-1]._event["author"]["name"]  # username of that event
-    if event_author in EPHEMERAL_SPACES_CONFIG["trusted_authors"]:
+    if payload.comment.content == "/help":
+        notify_pr(space_id=space_id, pr_num=pr_num, action="help")
+    elif event_author in EPHEMERAL_SPACES_CONFIG["trusted_authors"]:
         if payload.comment.content == "/trust_pr":
             configure_ephemeral_space(space_id=space_id, pr_num=pr_num, trusted_pr=True)
             notify_pr(space_id=space_id, pr_num=pr_num, action="trusted_pr")
@@ -544,6 +548,15 @@ You can access this PR's ephemeral Space at [{ci_space_id}](https://huggingface.
 _(This is an automated message.)_
 """
 
+NOTIFICATION_TEMPLATE_HELP = """\
+Here are the available commands:
+- `/trust_pr`: Grants temporary trust status to the PR, and can only be used by a trusted user. If a new commit is made by an untrusted user it will automatically revoke trust status.
+- `/untrust_pr`: Revokes trust status from the PR,can only be used by a trusted user on any pr (including his own PRs) and will reset the ephemeral space hardware, storage, secrets and variables.
+- `/help`: Shows this help message.
+To integrate gradio-space-ci into another space head into https://huggingface.co/spaces/Wauplin/gradio-space-ci and follow the instructions.
+_(This is an automated message.)
+"""
+
 ### TO MOVE TO ITS OWN MODULE
 # Taken from https://github.com/huggingface/huggingface_hub/issues/1808#issuecomment-1802341663