From 813b0196535c619643891d368ddf13432ca853cc Mon Sep 17 00:00:00 2001 From: fujie Date: Mon, 26 Jan 2026 15:29:26 +0800 Subject: [PATCH] release: GitHub Copilot SDK Pipe v0.1.1 --- .github/copilot-instructions.md | 3 ++- plugins/pipes/github-copilot-sdk/README.md | 8 ++++---- plugins/pipes/github-copilot-sdk/README_CN.md | 6 +++--- plugins/pipes/github-copilot-sdk/github_copilot_sdk.py | 3 ++- plugins/pipes/github-copilot-sdk/github_copilot_sdk_cn.py | 2 +- 5 files changed, 12 insertions(+), 10 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 9f2e34d..9ad7f08 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -100,13 +100,14 @@ description: 插件功能的简短描述。Brief description of plugin functiona | `author_url` | 作者主页链接 | `https://github.com/Fu-Jie/awesome-openwebui` | | `funding_url` | 赞助/项目链接 | `https://github.com/open-webui` | | `version` | 语义化版本号 | `0.1.0`, `1.2.3` | -| `icon_url` | 图标 (Base64 编码的 SVG) | 见下方图标规范 | +| `icon_url` | 图标 (Base64 编码的 SVG) | 仅 Action 插件**必须**提供。其他类型可选。 | | `requirements` | 额外依赖 (仅 OpenWebUI 环境未安装的) | `python-docx==1.1.2` | | `description` | 功能描述 | `将对话导出为 Word 文档` | #### 图标规范 (Icon Guidelines) - 图标来源：从 [Lucide Icons](https://lucide.dev/icons/) 获取符合插件功能的图标 +- 适用范围：Action 插件**必须**提供，其他插件可选 - 格式：Base64 编码的 SVG - 获取方法：从 Lucide 下载 SVG，然后使用 Base64 编码 - 示例格式： diff --git a/plugins/pipes/github-copilot-sdk/README.md b/plugins/pipes/github-copilot-sdk/README.md index ad5b94a..44ade3b 100644 --- a/plugins/pipes/github-copilot-sdk/README.md +++ b/plugins/pipes/github-copilot-sdk/README.md @@ -21,6 +21,7 @@ This is an advanced Pipe function for [OpenWebUI](https://github.com/open-webui/ * **🛠️ Zero-config Installation**: Automatically detects and downloads the GitHub Copilot CLI, ready to use out of the box. * **🔑 Secure Authentication**: Supports Fine-grained Personal Access Tokens for minimized permissions. * **🐛 Debug Mode**: Built-in detailed log output for easy connection troubleshooting. +* **⚠️ Single Node Only**: Due to local session storage, this plugin currently supports single-node OpenWebUI deployment or multi-node with sticky sessions enabled. ## 📦 Installation & Usage @@ -39,7 +40,7 @@ Find "GitHub Copilot" in the function list and click the **⚙️ (Valves)** ico | Parameter | Description | Default | | :--- | :--- | :--- | | **GH_TOKEN** | **(Required)** Your GitHub Token. | - | -| **MODEL_ID** | The model name to use. Recommended `gpt-5-mini` or `gpt-5`. | `gpt-5-mini` | +| **MODEL_ID** | The model name to use. | `gpt-5-mini` | | **CLI_PATH** | Path to the Copilot CLI. Will download automatically if not found. | `/usr/local/bin/copilot` | | **DEBUG** | Whether to enable debug logs (output to chat). | `True` | | **SHOW_THINKING** | Show model reasoning/thinking process. | `True` | @@ -56,10 +57,10 @@ For security, it is recommended to use a **Fine-grained Personal Access Token**: 1. Visit [GitHub Token Settings](https://github.com/settings/tokens?type=beta). 2. Click **Generate new token**. -3. **Repository access**: Select `All repositories` or `Public Repositories`. +3. **Repository access**: Select **Public repositories** (Required to access Copilot permissions). 4. **Permissions**: * Click **Account permissions**. - * Find **Copilot Requests**, select **Read and write** (or Access). + * Find **Copilot Requests** (It defaults to **Read-only**, no selection needed). 5. Generate and copy the Token. ## 📋 Dependencies @@ -73,7 +74,6 @@ This Pipe will automatically attempt to install the following dependencies: * **Stuck on "Waiting..."**: * Check if `GH_TOKEN` is correct and has `Copilot Requests` permission. - * Try changing `MODEL_ID` to `gpt-4o` or `copilot-chat`. * **Images not recognized**: * Ensure `MODEL_ID` is a model that supports multimodal input. * **CLI Installation Failed**: diff --git a/plugins/pipes/github-copilot-sdk/README_CN.md b/plugins/pipes/github-copilot-sdk/README_CN.md index 5e7eadb..1d175c5 100644 --- a/plugins/pipes/github-copilot-sdk/README_CN.md +++ b/plugins/pipes/github-copilot-sdk/README_CN.md @@ -21,6 +21,7 @@ * **🛠️ 零配置安装**：自动检测并下载 GitHub Copilot CLI，开箱即用。 * **🔑 安全认证**：支持 Fine-grained Personal Access Tokens，权限最小化。 * **🐛 调试模式**：内置详细的日志输出，方便排查连接问题。 +* **⚠️ 仅支持单节点**：由于会话状态存储在本地，本插件目前仅支持 OpenWebUI 单节点部署，或开启了会话粘性 (Sticky Session) 的多节点集群。 ## 📦 安装与使用 @@ -56,10 +57,10 @@ 1. 访问 [GitHub Token Settings](https://github.com/settings/tokens?type=beta)。 2. 点击 **Generate new token**。 -3. **Repository access**: 选择 `All repositories` 或 `Public Repositories`。 +3. **Repository access**: 选择 **Public repositories** (必须选择此项才能看到 Copilot 权限)。 4. **Permissions**: * 点击 **Account permissions**。 - * 找到 **Copilot Requests**，选择 **Read and write** (或 Access)。 + * 找到 **Copilot Requests** (默认即为 **Read-only**，无需手动修改)。 5. 生成并复制 Token。 ## 📋 依赖说明 @@ -73,7 +74,6 @@ * **一直显示 "Waiting..."**： * 检查 `GH_TOKEN` 是否正确且拥有 `Copilot Requests` 权限。 - * 尝试将 `MODEL_ID` 改为 `gpt-4o` 或 `copilot-chat`。 * **图片无法识别**： * 确保 `MODEL_ID` 是支持多模态的模型。 * **CLI 安装失败**： diff --git a/plugins/pipes/github-copilot-sdk/github_copilot_sdk.py b/plugins/pipes/github-copilot-sdk/github_copilot_sdk.py index de3f2bf..0d948b9 100644 --- a/plugins/pipes/github-copilot-sdk/github_copilot_sdk.py +++ b/plugins/pipes/github-copilot-sdk/github_copilot_sdk.py @@ -1,8 +1,9 @@ """ -title: GitHub Copilot Official SDK Pipe (Dynamic Models) +title: GitHub Copilot Official SDK Pipe author: Fu-Jie author_url: https://github.com/Fu-Jie/awesome-openwebui funding_url: https://github.com/open-webui +openwebui_id: ce96f7b4-12fc-4ac3-9a01-875713e69359 description: Integrate GitHub Copilot SDK. Supports dynamic models, multi-turn conversation, streaming, multimodal input, and infinite sessions (context compaction). version: 0.1.1 requirements: github-copilot-sdk diff --git a/plugins/pipes/github-copilot-sdk/github_copilot_sdk_cn.py b/plugins/pipes/github-copilot-sdk/github_copilot_sdk_cn.py index 6dc8996..4aff184 100644 --- a/plugins/pipes/github-copilot-sdk/github_copilot_sdk_cn.py +++ b/plugins/pipes/github-copilot-sdk/github_copilot_sdk_cn.py @@ -1,5 +1,5 @@ """ -title: GitHub Copilot 官方 SDK 管道 (动态模型版) +title: GitHub Copilot Official SDK Pipe author: Fu-Jie author_url: https://github.com/Fu-Jie/awesome-openwebui funding_url: https://github.com/open-webui