Link github webhook data docs for each payload type for developer convenience

Author: budak7273

fred/libraries/createembed.py

@@ -79,6 +79,7 @@ def DM(text: str) -> nextcord.Embed:
     return embed
 
 
+# data format: expand `commits` properties on: https://docs.github.com/en/webhooks/webhook-events-and-payloads#push
 def format_commit(commit: dict) -> tuple[str, str]:
     hash_id = f'`{commit["id"][:8]}`'
     commit_message = commit["message"].split("\n")[0].replace("*", r"\*")
@@ -91,6 +92,7 @@ def format_commit(commit: dict) -> tuple[str, str]:
     return f"{commit_message}\n", f'{change_summary_icons} - by {attribution} {ts} [{hash_id}]({commit["url"]})\n'
 
 
+# data format: https://docs.github.com/en/webhooks/webhook-events-and-payloads#push
 def push(data: dict) -> nextcord.Embed:
     if data["forced"]:
         colour = config.ActionColours.fetch("Red")
@@ -100,10 +102,10 @@ def push(data: dict) -> nextcord.Embed:
         forced = ""
 
     if data["created"]:
-        embed = create(data)
+        embed = push_ref_create(data)
         return embed
     elif data["deleted"]:
-        embed = delete(data)
+        embed = push_ref_delete(data)
         return embed
 
     commits = data["commits"]
@@ -127,6 +129,7 @@ def push(data: dict) -> nextcord.Embed:
     return embed
 
 
+# data format: (note: docs on 'added' has empty data for `member` but it probably shares it with 'removed'?) https://docs.github.com/en/webhooks/webhook-events-and-payloads?actionType=removed#member
 def contributor_added(data: dict) -> nextcord.Embed:
     embed = nextcord.Embed(
         title=f'__**{data["member"]["login"]}**__ has been added to the Repository!',
@@ -139,6 +142,7 @@ def contributor_added(data: dict) -> nextcord.Embed:
     return embed
 
 
+# data format: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request
 def pull_request(data: dict) -> nextcord.Embed:
     action = data["action"]
     colour = config.ActionColours.fetch("Orange")
@@ -189,7 +193,8 @@ def pull_request(data: dict) -> nextcord.Embed:
     return embed
 
 
-def create(data: dict) -> nextcord.Embed:
+# data format: https://docs.github.com/en/webhooks/webhook-events-and-payloads#push
+def push_ref_create(data: dict) -> nextcord.Embed:
     _, ref_type, ref_name = data["ref"].split("/")
     match ref_type:
         case "tags":
@@ -210,7 +215,8 @@ def create(data: dict) -> nextcord.Embed:
     return embed
 
 
-def delete(data: dict) -> nextcord.Embed:
+# data format: https://docs.github.com/en/webhooks/webhook-events-and-payloads#push
+def push_ref_delete(data: dict) -> nextcord.Embed:
     _, ref_type, ref_name = data["ref"].split("/")
     embed = nextcord.Embed(
         title=f'{ref_type} "{ref_name}" deleted in {repo_name}',
@@ -223,6 +229,7 @@ def delete(data: dict) -> nextcord.Embed:
     return embed
 
 
+# data format: https://docs.github.com/en/webhooks/webhook-events-and-payloads#release
 def release(data: dict) -> nextcord.Embed:
     state = "pre-release" if data["release"]["prerelease"] else "release"
     embed = nextcord.Embed(
@@ -236,6 +243,7 @@ def release(data: dict) -> nextcord.Embed:
     return embed
 
 
+# data format: https://docs.github.com/en/webhooks/webhook-events-and-payloads#issues
 def issue(data: dict) -> nextcord.Embed:
     match action := data["action"]:
         case "opened":
@@ -257,6 +265,7 @@ def issue(data: dict) -> nextcord.Embed:
     return embed
 
 
+# data format: https://docs.github.com/en/webhooks/webhook-events-and-payloads#issue_comment
 def issue_comment(data: dict) -> nextcord.Embed:
     author = data["comment"]["user"]
     embed = nextcord.Embed(