logo
1
1
WeChat Login
docs: 重构 README 聚焦 Translate NPC 与部署说明

Translate NPC

一个基于 requests 的翻译 NPC,部署在 CNB 平台上,通过 AI 接口自动翻译 Issue / PR 中的评论内容。

  • 支持 自动翻译(根据源语言自动判断翻译方向)和 指定语言翻译(如翻译为中文、英文、日文等)
  • 自动识别源语言,智能选择目标语言
  • 若原文已是目标语言,则进行润色优化

.cnb/settings.yml 中定义角色来决定翻译行为,内置支持 Translate(自动)、ToChineseToEnglishToJapaneseToKoreanToFrenchToSpanishToGerman 等角色。

依赖

  • Python 3.12+
  • requests

安装依赖:

pip install -r requirements.txt

运行方式

直接运行:

python main.py

程序依赖环境变量。CNB_* 变量由平台自动注入。

环境变量

必需(平台自动注入)

  • CNB_EVENT — 触发事件名称
  • CNB_API_ENDPOINT — CNB API 地址
  • CNB_REPO_SLUG — 仓库标识
  • CNB_NPC_NAME — NPC 角色名称(如 Translate:ToChinese
  • CNB_NPC_TRIGGER_CONTENT — 触发翻译的原始内容
  • CNB_TOKENCNB_TOKEN_FOR_AI — 平台认证 Token

可选

  • NPC_BASE_URL — AI 接口地址,不配置时默认使用 ${CNB_API_ENDPOINT}/${CNB_REPO_SLUG}/-/ai/
  • NPC_KEY — AI 接口鉴权密钥,不配置时依次回退至 CNB_TOKEN_FOR_AICNB_TOKEN

事件支持

当前支持:

  • issue.comment@npc
  • pull_request.comment@npc

部署

  • Dockerfile 基于 python:3.12-alpine
  • .cnb.yml 配置了自动构建和 NPC 触发规则
  • 推送代码时自动构建镜像并推送到仓库制品库