fix: enhance Github plugin (#2123)

Author: Mairuis

tools/github/manifest.yaml

@@ -2,9 +2,7 @@ author: langgenius
 created_at: "2024-09-20T08:03:44.658609186Z"
 description:
   en_US: GitHub is an online software source code hosting service.
-  pt_BR:
-    GitHub é uma plataforma online para serviços de hospedagem de código fonte
-    de software.
+  pt_BR: GitHub é uma plataforma online para serviços de hospedagem de código fonte de software.
   zh_Hans: GitHub是一个在线软件源代码托管服务平台。
 icon: icon.svg
 label:
@@ -13,18 +11,18 @@ label:
   zh_Hans: GitHub
 meta:
   arch:
-    - amd64
-    - arm64
+  - amd64
+  - arm64
   runner:
     entrypoint: main
     language: python
     version: "3.12"
-  version: 0.2.8
+  version: 0.2.9
   minimum_dify_version: 1.7.0
 name: github
 plugins:
   tools:
-    - provider/github.yaml
+  - provider/github.yaml
 resource:
   memory: 1048576
   permission:
@@ -34,6 +32,6 @@ resource:
     tool:
       enabled: true
 tags:
-  - utilities
+- utilities
 type: plugin
-version: 0.2.8
+version: 0.3.0

tools/github/provider/github.py

@@ -24,8 +24,9 @@ def _oauth_get_authorization_url(self, redirect_uri: str, system_credentials: Ma
         params = {
             "client_id": system_credentials["client_id"],
             "redirect_uri": redirect_uri,
-            "scope": system_credentials.get("scope", "read:user"),
+            "scope": system_credentials.get("scope", "read:user repo"),
             "state": state,
+            # Optionally: allow_signup, login, etc.
         }
         return f"{self._AUTH_URL}?{urllib.parse.urlencode(params)}"
 
@@ -38,6 +39,7 @@ def _oauth_get_credentials(
         code = request.args.get("code")
         if not code:
             raise ToolProviderOAuthError("No code provided")
+        # Optionally: validate state here
 
         data = {
             "client_id": system_credentials["client_id"],
@@ -57,6 +59,10 @@ def _oauth_get_credentials(
     def _oauth_refresh_credentials(
         self, redirect_uri: str, system_credentials: Mapping[str, Any], credentials: Mapping[str, Any]
     ) -> ToolOAuthCredentials:
+        """
+        Refresh the credentials
+        """
+        # TODO: Implement the refresh credentials logic
         return ToolOAuthCredentials(credentials=credentials, expires_at=-1)
 
     def _validate_credentials(self, credentials: dict) -> None:

tools/github/provider/github.yaml

@@ -18,42 +18,42 @@ credentials_for_provider:
 
 oauth_schema:
   client_schema:
-    - name: "client_id"
-      type: "secret-input"
-      required: true
-      url: https://github.com/settings/applications/new
-      placeholder:
-        en_US: "Please input your Client ID"
-        zh_Hans: "请输入你的 Client ID"
-        pt_BR: "Insira seu Client ID"
-      help:
-        en_US: "Client ID is used to authenticate requests to the GitHub API."
-        zh_Hans: "Client ID 用于认证请求到 GitHub API。"
-        pt_BR: "Client ID é usado para autenticar solicitações à API do GitHub."
-      label:
-        zh_Hans: "Client ID"
-        en_US: "Client ID"
-    - name: "client_secret"
-      type: "secret-input"
-      required: true
-      url: https://github.com/settings/applications/new
-      placeholder:
-        en_US: "Please input your Client Secret"
-        zh_Hans: "请输入你的 Client Secret"
-        pt_BR: "Insira seu Client Secret"
-      help:
-        en_US: "Client Secret is used to authenticate requests to the GitHub API."
-        zh_Hans: "Client Secret 用于认证请求到 GitHub API。"
-        pt_BR: "Client Secret é usado para autenticar solicitações à API do GitHub."
-      label:
-        zh_Hans: "Client Secret"
-        en_US: "Client Secret"
+  - name: "client_id"
+    type: "secret-input"
+    required: true
+    url: https://github.com/settings/applications/new
+    placeholder:
+      en_US: "Please input your Client ID"
+      zh_Hans: "请输入你的 Client ID"
+      pt_BR: "Insira seu Client ID"
+    help:
+      en_US: "Client ID is used to authenticate requests to the GitHub API."
+      zh_Hans: "Client ID 用于认证请求到 GitHub API。"
+      pt_BR: "Client ID é usado para autenticar solicitações à API do GitHub."
+    label:
+      zh_Hans: "Client ID"
+      en_US: "Client ID"
+  - name: "client_secret"
+    type: "secret-input"
+    required: true
+    url: https://github.com/settings/applications/new
+    placeholder:
+      en_US: "Please input your Client Secret"
+      zh_Hans: "请输入你的 Client Secret"
+      pt_BR: "Insira seu Client Secret"
+    help:
+      en_US: "Client Secret is used to authenticate requests to the GitHub API."
+      zh_Hans: "Client Secret 用于认证请求到 GitHub API。"
+      pt_BR: "Client Secret é usado para autenticar solicitações à API do GitHub."
+    label:
+      zh_Hans: "Client Secret"
+      en_US: "Client Secret"
   credentials_schema:
-    - name: "access_tokens"
-      type: "secret-input"
-      label:
-        zh_Hans: "Access Token"
-        en_US: "Access Token"
+  - name: "access_tokens"
+    type: "secret-input"
+    label:
+      zh_Hans: "Access Token"
+      en_US: "Access Token"
 
 extra:
   python:
@@ -62,9 +62,7 @@ identity:
   author: langgenius
   description:
     en_US: GitHub is an online software source code hosting service.
-    pt_BR:
-      GitHub é uma plataforma online para serviços de hospedagem de código fonte
-      de software.
+    pt_BR: GitHub é uma plataforma online para serviços de hospedagem de código fonte de software.
     zh_Hans: GitHub 是一个在线软件源代码托管服务平台。
   icon: icon.svg
   label:
@@ -73,17 +71,28 @@ identity:
     zh_Hans: GitHub
   name: github
   tags:
-    - utilities
+  - utilities
 tools:
-  - tools/github_repositories.yaml
-  - tools/github_repository_readme.yaml
-  - tools/github_repository_info.yaml
-  - tools/github_repository_issues.yaml
-  - tools/github_repository_pulls.yaml
-  - tools/github_repository_releases.yaml
-  - tools/github_repository_contributors.yaml
-  - tools/github_repository_commits.yaml
-  - tools/github_repository_contents.yaml
-  - tools/github_user_info.yaml
-  - tools/github_user_repos.yaml
-  - tools/github_search_code.yaml
+- tools/github_repositories.yaml
+- tools/github_repository_readme.yaml
+- tools/github_repository_info.yaml
+- tools/github_repository_issues.yaml
+- tools/github_repository_pulls.yaml
+- tools/github_repository_releases.yaml
+- tools/github_repository_contributors.yaml
+- tools/github_repository_commits.yaml
+- tools/github_repository_contents.yaml
+- tools/github_user_info.yaml
+- tools/github_user_repos.yaml
+- tools/github_search_code.yaml
+# Pull Request tools
+- tools/github_pull_detail.yaml
+- tools/github_pull_files.yaml
+- tools/github_pull_comments.yaml
+- tools/github_pull_reviews.yaml
+- tools/github_create_pull.yaml
+- tools/github_merge_pull.yaml
+- tools/github_update_pull.yaml
+- tools/github_create_pull_review.yaml
+# Issue tools
+- tools/github_issue_comment.yaml

tools/github/requirements.txt

@@ -1 +1 @@
-dify_plugin==0.4.2
+dify_plugin==0.6.0b10

tools/github/tools/github_create_pull.py

@@ -0,0 +1,107 @@
+import json
+from collections.abc import Generator
+from datetime import datetime
+from typing import Any
+
+import requests
+
+from dify_plugin import Tool
+from dify_plugin.entities.provider_config import CredentialType
+from dify_plugin.entities.tool import ToolInvokeMessage
+from dify_plugin.errors.model import InvokeError
+
+from .github_error_handler import handle_github_api_error
+
+
+class GithubCreatePullTool(Tool):
+    def _invoke(self, tool_parameters: dict[str, Any]) -> Generator[ToolInvokeMessage, None, None]:
+        """
+        Create a new pull request
+        """
+        owner = tool_parameters.get("owner", "")
+        repo = tool_parameters.get("repo", "")
+        title = tool_parameters.get("title", "")
+        head = tool_parameters.get("head", "")
+        base = tool_parameters.get("base", "")
+        body = tool_parameters.get("body", "")
+        draft = tool_parameters.get("draft", False)
+        maintainer_can_modify = tool_parameters.get("maintainer_can_modify", True)
+        credential_type = self.runtime.credential_type
+
+        if not owner:
+            yield self.create_text_message("Please input owner")
+            return
+        if not repo:
+            yield self.create_text_message("Please input repo")
+            return
+        if not title:
+            yield self.create_text_message("Please input title")
+            return
+        if not head:
+            yield self.create_text_message("Please input head branch")
+            return
+        if not base:
+            yield self.create_text_message("Please input base branch")
+            return
+
+        if credential_type == CredentialType.API_KEY and "access_tokens" not in self.runtime.credentials:
+            yield self.create_text_message("GitHub API Access Tokens is required.")
+            return
+
+        if credential_type == CredentialType.OAUTH and "access_tokens" not in self.runtime.credentials:
+            yield self.create_text_message("GitHub OAuth Access Tokens is required.")
+            return
+
+        access_token = self.runtime.credentials.get("access_tokens")
+        try:
+            headers = {
+                "Content-Type": "application/vnd.github+json",
+                "Authorization": f"Bearer {access_token}",
+                "X-GitHub-Api-Version": "2022-11-28",
+            }
+            s = requests.session()
+            api_domain = "https://api.github.com"
+            url = f"{api_domain}/repos/{owner}/{repo}/pulls"
+
+            payload = {
+                "title": title,
+                "head": head,
+                "base": base,
+                "draft": draft,
+                "maintainer_can_modify": maintainer_can_modify,
+            }
+            if body:
+                payload["body"] = body
+
+            response = s.request(method="POST", headers=headers, url=url, json=payload)
+
+            if response.status_code == 201:
+                pull = response.json()
+
+                result = {
+                    "success": True,
+                    "number": pull.get("number", 0),
+                    "title": pull.get("title", ""),
+                    "state": pull.get("state", ""),
+                    "url": pull.get("html_url", ""),
+                    "draft": pull.get("draft", False),
+                    "head": {
+                        "ref": pull.get("head", {}).get("ref", ""),
+                        "sha": pull.get("head", {}).get("sha", "")[:7] if pull.get("head", {}).get("sha") else "",
+                    },
+                    "base": {
+                        "ref": pull.get("base", {}).get("ref", ""),
+                    },
+                    "created_at": datetime.strptime(
+                        pull.get("created_at", ""), "%Y-%m-%dT%H:%M:%SZ"
+                    ).strftime("%Y-%m-%d %H:%M:%S") if pull.get("created_at") else "",
+                }
+
+                s.close()
+                yield self.create_text_message(json.dumps(result, ensure_ascii=False, indent=2))
+            else:
+                handle_github_api_error(response, f"create pull request in {owner}/{repo}")
+        except InvokeError as e:
+            yield self.create_text_message(f"❌ {str(e)}")
+        except Exception as e:
+            yield self.create_text_message(f"❌ GitHub API request failed: {e}")