dsh-github-studio 0.0.0-stage → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 DeepSeek GitHub Connect contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,160 @@
1
- # Temporary Holding Version
1
+ # DeepSeek GitHub Connect
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ **面向 DeepSeek Harness 的 GitHub 连接与发布插件。** 在聊天中读取项目、准备代码提交,在设置页管理仓库、生成项目介绍并发布程序版本。
4
+
5
+ > 第三方开源项目,非 DeepSeek 或 GitHub 官方产品。适用于 Windows 上的 DeepSeek Harness;不适用于普通的 `chat.deepseek.com` 聊天网页。
6
+
7
+ ![DeepSeek GitHub Connect:仓库管理与发布入口](docs/images/01-cover.png)
8
+
9
+ ## 项目概述
10
+
11
+ DeepSeek GitHub Connect 将 GitHub 仓库操作集成到 Harness 的工具调用与设置界面中。它围绕个人开发者的实际流程设计:阅读项目、整理介绍、创建仓库、准备修改,以及向 Release 上传安装包。
12
+
13
+ 仓库读取与官网跳转可以直接进行;创建仓库、提交文件、创建 Release 和上传发布附件先形成操作预览,再由用户确认执行。删除入口仅跳转 GitHub 设置页,最终删除在官网完成。
14
+
15
+ ## 功能一览
16
+
17
+ | 模块 | 能力 |
18
+ | --- | --- |
19
+ | GitHub 连接 | OAuth Device Flow 登录;本机 Windows DPAPI 加密保存令牌 |
20
+ | 仓库浏览 | 浏览已授权仓库、目录和文本文件,查看版本及附件链接 |
21
+ | 聊天工具 | 搜索公开仓库和代码、读取文件、准备建库及提交操作 |
22
+ | 官网搜索 | 仓库/代码分类,高级筛选,直接在浏览器打开 GitHub 原生搜索 |
23
+ | AI 项目介绍 | 传入源码、README 或源码 ZIP,根据可读文本生成可编辑介绍 |
24
+ | 文案草稿 | 新建仓库介绍、Release 标题及更新说明自动保存和恢复 |
25
+ | 程序发布 | 创建版本、填写更新说明、选择安装包并确认上传 |
26
+ | 操作确认 | 明确显示账号、仓库及待执行内容;失败不盲目重试 |
27
+ | 删除入口 | 二次提示后跳转对应仓库的官网设置页 |
28
+
29
+ ## 使用界面
30
+
31
+ ### 传入代码,让 AI 协助撰写项目介绍
32
+
33
+ 在“仓库 → 新建仓库”中,点击仓库名称旁的“传入程序/代码”。文件成功暂存后,“AI 自动介绍”按钮才会启用。AI 读取选中文件中的源码或说明片段,生成介绍并回填;用户可以继续修改,再预览创建仓库。
34
+
35
+ ![传入代码并生成仓库介绍](docs/images/02-ai-intro.png)
36
+
37
+ - 支持常见代码文件、README 和包含源码的 ZIP。
38
+ - 不执行安装包,也不根据文件名猜测功能。
39
+ - `.exe`、`.msi`、`.apk` 或仅含二进制的压缩包需补充源码或可读说明。
40
+ - 用于介绍的导入文件仅暂存在本机,与待发布的安装包分开管理。
41
+ - 生成介绍使用 Harness 默认模型与现有模型凭据,会产生对应模型服务的调用用量。
42
+
43
+ ### 文案自动保存,方便继续编辑
44
+
45
+ 新建仓库介绍以及程序发布页的版本标题、更新说明,在停止输入后自动保存到本机 GitHub 工作区。再次打开对应表单时,自动恢复可用草稿;版本文案按仓库保存。
46
+
47
+ ![发布文案自动保存与恢复](docs/images/03-autosave.png)
48
+
49
+ 草稿是本机文案备份,不是已经发布的 GitHub 内容。准备创建或发布操作后,会清理相应表单草稿;真正执行仍需到操作预览中确认。暂存安装包不等于已上传到 GitHub。
50
+
51
+ > 三张图片使用演示账号和示例项目,展示产品操作流程,不表示这些示例项目是本仓库附带的软件。
52
+
53
+ ## 安装
54
+
55
+ ### 环境要求
56
+
57
+ - Windows;登录凭据保护依赖 Windows DPAPI CurrentUser。
58
+ - DeepSeek Harness。开发基线为 `0.2.2-rc.1`,其他版本的插件接口可能存在差异。
59
+ - 网络能访问 GitHub 登录页、`api.github.com` 和 `uploads.github.com`。
60
+ - 使用 AI 介绍时,需在 Harness 中配置可用默认模型。
61
+
62
+ ### 通过 GitHub 仓库安装
63
+
64
+ 在 Harness 中打开“插件 → 添加插件”,输入本仓库地址:
65
+
66
+ ```text
67
+ https://github.com/zhaohaix/DeepSeek-GitHub
68
+ ```
69
+
70
+ 安装并启用后,进入“设置 → GitHub”。本仓库包含已构建的 `lib/` 文件;使用本地源码目录安装时,请保持目录位置稳定。
71
+
72
+ ### 使用本地源码或安装包
73
+
74
+ 也可以克隆项目后,在“添加插件”中输入本地项目目录。若使用构建好的 `.tgz`,按当前 Harness 插件管理器支持的本地包方式安装;项目附带 Windows 安装脚本,运行前需完全退出客户端。
75
+
76
+ ```sh
77
+ git clone https://github.com/zhaohaix/DeepSeek-GitHub.git
78
+ cd DeepSeek-GitHub
79
+ npm ci
80
+ npm run verify
81
+ ```
82
+
83
+ ## 配置 GitHub 登录
84
+
85
+ **公开版本没有预置个人 OAuth App Client ID。** 首次登录前需配置自己的 GitHub OAuth App:
86
+
87
+ 1. 在 GitHub 的 **Settings → Developer settings → OAuth Apps** 创建应用。
88
+ 2. 填写自己的应用名称及主页信息,并在应用设置中启用 **Device Flow**。
89
+ 3. 将公开的 **Client ID** 填入插件“设置 → GitHub”的登录应用配置。
90
+ 4. 点击“登录 GitHub”,打开 GitHub 官方设备授权页,输入显示的设备代码并授权。
91
+
92
+ 此流程不要求在插件中填写 Client Secret。不要把访问令牌、Client Secret 或本机配置上传到仓库。
93
+
94
+ | 配置状态 | 可使用范围 |
95
+ | --- | --- |
96
+ | 未配置 Client ID、未登录 | 官网搜索和高级筛选可使用浏览器账号;插件内需要认证的仓库与发布流程不可开始使用 |
97
+ | 已配置并完成授权 | 在账号与令牌权限内使用仓库、提交和发布功能 |
98
+ | 本机已有仍有效的令牌 | 清空预置 Client ID 不会主动撤销令牌;失效或退出后需先配置再登录 |
99
+
100
+ 授权请求使用 `repo` 范围,涉及公开及私有仓库,请核对 GitHub 授权页。插件不申请 `delete_repo`;删除按钮只打开官网。
101
+
102
+ ## 典型操作流程
103
+
104
+ ### 阅读与分析项目
105
+
106
+ 在设置页选择仓库,或在聊天中提供 `owner/repository`、文件路径或 GitHub 链接。例如:
107
+
108
+ ```text
109
+ 请读取这个仓库的 README,再介绍目录结构和主要模块。
110
+ ```
111
+
112
+ 搜索返回的是检索线索,建议继续读取原文后再下结论。REST 代码搜索与官网新代码搜索的语法和索引能力并非完全一致。
113
+
114
+ ### 创建仓库
115
+
116
+ 填写仅包含英文字母、数字、连字符、下划线或英文句点的仓库名,手写介绍或传入源码后生成介绍,再选择公开/私有并预览创建。默认公开,请在确认页检查可见性。
117
+
118
+ ### 发布程序
119
+
120
+ 选择自己的仓库,填写版本标签、目标分支、版本标题和更新说明。先预览并确认创建 Release,再选择已暂存的安装包,预览并确认上传。安装包上传与源码编译是两项不同工作,本插件不负责自动编译。
121
+
122
+ ### 跳转官网搜索或删除
123
+
124
+ 搜索框提交后由浏览器打开 GitHub 官网,使用浏览器中的登录账号。删除按钮位于自己的仓库详情,确认后打开该仓库设置页,在官网按提示完成最终删除。
125
+
126
+ ## 隐私与安全边界
127
+
128
+ - 本机数据默认保存在用户主目录下 `.dsh/github-connect`,包括加密令牌、暂存文件、诊断日志和文案工作区。
129
+ - 令牌使用 Windows DPAPI CurrentUser 加密,不通过普通页面状态接口返回。
130
+ - 本地 API 限定宿主浏览器身份及本机访问;本项目面向个人桌面环境,不适合作为公开多租户服务。
131
+ - ZIP 只读取符合限制的文本,不运行其中的程序;会跳过依赖目录、部分构建产物和明显凭据文件。启发式筛选不能保证发现所有敏感信息。
132
+ - AI 将所选文本发送给 Harness 配置的模型服务,生成结果需审阅,不能视为已验证的软件功能或测试结论。
133
+ - 若写入后网络中断,请先核实 GitHub 上的实际结果,再决定是否重新准备操作。
134
+ - 当前没有自动刷新过期 OAuth 令牌的完整续期流程;应用启用可过期令牌时,可能需要重新登录。
135
+
136
+ ## 常见问题
137
+
138
+ **是否必须使用网络加速?** 取决于网络能否稳定访问 GitHub 官方地址。插件不提供镜像中转;浏览器和 Harness 后台都需要正常连接。
139
+
140
+ **为什么安装包传入后仍不能生成介绍?** 二进制文件不能直接提供可靠的功能证据,请补充源码 ZIP、README 或代码文件。
141
+
142
+ **新建仓库后列表里没有显示?** 点击标签栏右侧的“刷新库”,同步更新仓库列表与发布下拉框。
143
+
144
+ **插件登录与浏览器登录是否相同?** 两者分别管理。官网搜索和删除跳转使用浏览器账号;插件 API 使用设备授权取得的本机令牌。
145
+
146
+ **为什么会显示未连接?** 可能是令牌失效、凭据读取失败或网络异常。后台脱敏日志用于区分原因,不应仅凭界面状态判断令牌已被删除。
147
+
148
+ ## 开发与贡献
149
+
150
+ ```sh
151
+ npm ci
152
+ npm run verify
153
+ npm run release:check
154
+ npm pack
155
+ npm run release:source
156
+ ```
157
+
158
+ 公开打包检查要求预置 Client ID 为空,并排除个人运行资料、日志、浏览器缓存与凭据。请勿将整个本机开发目录直接上传。欢迎通过 Issue 报告可复现问题;提交截图或日志前请去除个人信息与秘密值。
159
+
160
+ 本项目使用 MIT License。第三方依赖遵循各自许可证;不附带或重新分发 DeepSeek Harness 宿主运行时。
@@ -0,0 +1,3 @@
1
+ - insert:
2
+ - id: github-connect
3
+ name: dsh-github-studio