✨ add CI scripts for automatic guild features updates

Author: Paillat-dev

.github/workflows/sync-guild-features.yml

@@ -0,0 +1,34 @@
+name: "Sync Guild Features"
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * 1,5'
+
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+permissions: write-all
+
+jobs:
+  sync-guild-features:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout Repository"
+        uses: actions/checkout@v4
+      - name: "Setup Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: "Install uv"
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Sync dependencies
+        run: uv sync --no-python-downloads --group dev --group ci
+      - name: "Run guild features sync"
+        run: uv run python -m scripts.sync_guild_features
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

pyproject.toml

@@ -74,6 +74,9 @@ dev = [
     "pytest-asyncio~=0.24.0",
     "ruff>=0.11.9",
 ]
+ci = [
+    "pygithub>=2.7.0",
+]
 
 [tool.hatch.version]
 source = "vcs"

scripts/__init__.py

@@ -0,0 +1,51 @@
+import os
+import sys
+import json
+from pathlib import Path
+from github import Github
+from github import Auth
+import re
+
+from .utils import get_features_blob, format_path, lint_path, GUILD_FEATURES_GIST_URL
+from ..utils import create_update_pr
+
+CI = os.environ.get("CI", "false").lower() in ("true", "1", "yes")
+
+GUILD_FEATURES_PATH = Path.cwd() / "discord" / "types" / "guild.py"
+GUILD_FEATURES_VARIABLE_NAME = "GuildFeature"
+GUILD_FEATURES_PATTERN = re.compile(rf"{GUILD_FEATURES_VARIABLE_NAME}\s*=\s*Literal\[(.*?)\]", re.DOTALL)
+
+
+def main():
+    with GUILD_FEATURES_PATH.open(encoding="utf-8") as file:
+        content = file.read()
+
+    features_blob = get_features_blob()
+    features_blob.sort()
+    features_blob_str = ", ".join(f'"{feature}"' for feature in features_blob)
+    new_content = GUILD_FEATURES_PATTERN.sub(f"{GUILD_FEATURES_VARIABLE_NAME} = Literal[{features_blob_str}]", content)
+
+    with GUILD_FEATURES_PATH.open("w", encoding="utf-8") as file:
+        file.write(new_content)
+
+    format_path(GUILD_FEATURES_PATH)
+    lint_path(GUILD_FEATURES_PATH)
+    with GUILD_FEATURES_PATH.open(encoding="utf-8") as file:
+        updated_content = file.read()
+    if updated_content == content:
+        print("No changes made to guild features.")
+        return
+    if CI:
+        create_update_pr(
+            commit_message="chore: Update guild features",
+            branch_prefix="sync-guild-features",
+            title="Update guild features",
+            body=f"This pull request automatically updates the guild features type, based on {GUILD_FEATURES_GIST_URL.split('/raw')[0]}. Please review the changes. and merge if everything looks good.",
+            path=GUILD_FEATURES_PATH,
+        )
+    else:
+        print("Not running in CI, skipping PR creation.")
+
+
+if __name__ == "__main__":
+    main()

scripts/sync_guild_features/__init__.py

@@ -0,0 +1,68 @@
+import requests
+import subprocess
+from pathlib import Path
+from ruff.__main__ import (  # type: ignore[import-untyped]
+    find_ruff_bin,
+)
+
+# https://gist.github.com/advaith1/a82065c4049345b38f526146d6ecab96
+GUILD_FEATURES_GIST_URL = (
+    "https://gist.githubusercontent.com/advaith1/a82065c4049345b38f526146d6ecab96/raw/guildfeatures.json"
+)
+
+
+def get_features_blob() -> list[str]:
+    """
+    Fetches the latest guild features from the Gist URL.
+
+    Returns
+    -------
+        list[str]: A list of guild feature strings.
+    """
+    response = requests.get(GUILD_FEATURES_GIST_URL, timeout=10)
+
+    if response.status_code != 200:
+        raise ValueError(f"Failed to fetch guild features: {response.status_code}")
+
+    return response.json()
+
+
+def format_path(path: Path) -> str:
+    """
+    Formats the given path with ruff.
+
+    Parameters
+    ----------
+        path (Path): The path to format.
+    """
+    result = subprocess.run(
+        [find_ruff_bin(), "format", str(path.absolute())],
+        text=True,
+        capture_output=True,
+        check=True,
+        cwd=Path.cwd(),
+    )
+    result.check_returncode()
+    return result.stdout
+
+
+def lint_path(path: Path) -> str:
+    """
+    Lints the given path with ruff.
+
+    Parameters
+    ----------
+        path (Path): The path to format.
+    """
+    result = subprocess.run(
+        [find_ruff_bin(), "check", "--fix", str(path.absolute())],
+        text=True,
+        capture_output=True,
+        check=True,
+        cwd=Path.cwd(),
+    )
+    result.check_returncode()
+    return result.stdout
+
+
+__all__ = ("get_features_blob", "format_path", "lint_path", "GUILD_FEATURES_GIST_URL")

scripts/sync_guild_features/__main__.py

@@ -0,0 +1,3 @@
+from .pr import create_update_pr
+
+__all__ = ("create_update_pr",)

scripts/sync_guild_features/utils.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+import os
+import sys
+import datetime
+import subprocess
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from github import Github
+from github import Auth
+
+if TYPE_CHECKING:
+    from github.PullRequest import PullRequest
+
+
+def ident() -> None:
+    subprocess.run(["/usr/bin/git", "config", "--global", "user.name", "github-actions[bot]"], check=True)
+    subprocess.run(
+        ["/usr/bin/git", "config", "--global", "user.email", "github-actions[bot]@users.noreply.github.com"], check=True
+    )
+
+
+def create_update_pr(commit_message: str, branch_prefix: str, title: str, body: str, path: str | Path) -> None:
+    """
+    Creates or updates a pull request with the given title and body.
+
+    Parameters
+    ----------
+        title (str): The title of the pull request.
+        branch_prefix (str): The prefix for the branch name.
+        body (str): The body of the pull request.
+        base_branch (str): The base branch to create the PR against. Defaults to "main".
+    """
+    github = Github(os.environ["GITHUB_TOKEN"])
+    repo = github.get_repo(os.environ["GITHUB_REPOSITORY"])
+    base_branch = subprocess.run(
+        ["/usr/bin/git", "rev-parse", "--abbrev-ref", "HEAD"],
+        check=True,
+        capture_output=True,
+        text=True,
+    ).stdout.strip()
+    ident()
+    print(f"Creating/updating PR in {repo.full_name} on branch {base_branch} with prefix {branch_prefix}")
+
+    # get all prs and see if there is one whose branch starts with the branch_prefix
+    prs = repo.get_pulls(state="open", sort="created", base=base_branch)
+    pull_request: None | PullRequest = None
+    for pr in prs:
+        if pr.head.ref.startswith(branch_prefix):
+            branch_name: str = pr.head.ref
+            subprocess.run(
+                ["/usr/bin/git", "checkout", branch_name],
+                check=False,
+            )
+            pull_request = pr
+            break
+    else:
+        branch_name = f"{branch_prefix}-{datetime.datetime.now().strftime('%Y%m%d%H%M%S')}"
+        subprocess.run(
+            ["/usr/bin/git", "checkout", "-b", branch_name],
+            check=False,
+        )
+
+    if not subprocess.run(["/usr/bin/git", "status", "--porcelain"], check=False, capture_output=True).stdout:
+        print("No changes to commit.")
+        return
+
+    subprocess.run(
+        ["/usr/bin/git", "add", str(path)],
+        check=False,
+    )
+    subprocess.run(
+        ["/usr/bin/git", "commit", "-m", title],
+        check=False,
+    )
+    subprocess.run(
+        ["/usr/bin/git", "push", "-u", "origin", branch_name],
+        check=False,
+    )
+
+    if not pull_request:
+        pull_request = repo.create_pull(
+            title=title,
+            body=body,
+            head=branch_name,
+            base=base_branch,
+        )
+        print(f"Created new PR #{pull_request.number}: {pull_request.title}")
+
+
+__all__ = ("create_update_pr",)