xeonvs/open-code-review-toolkit
GitHub: xeonvs/open-code-review-toolkit
该项目为 Alibaba Open Code Review 提供 GitLab CI 集成层,支持在流水线中自动化运行代码审查并安全发布结果到 Merge Request。
Stars: 0 | Forks: 0
# 开源 Code Review 工具包
Open Code Review Toolkit 是 [Alibaba Open Code Review](https://github.com/alibaba/open-code-review) 的非官方 GitLab CI 集成层。它提供有界仓库上下文生成、环境驱动的 OCR 配置、预检验证以及安全的 GitLab merge-request 发布。它**不会**捆绑或下载 `ocr` 二进制文件。
## 安装
从 PyPI 安装 Python 包,并单独安装受支持的 OCR 二进制文件:
```
python -m pip install open-code-review-toolkit
ocr --version
ocr-ci --help
```
当前的兼容性目标是 OCR `1.7.13`。CI 应锁定该版本,并在执行前验证其发布的 checksum。
审查输出默认为英语。设置 `OCR_REVIEW_LANGUAGE=Russian` 以在 OCR 配置和生成的审查上下文中一致地使用俄语。
稳定版发布在 [PyPI](https://pypi.org/project/open-code-review-toolkit/),并在相应的 [GitHub Release](https://github.com/xeonvs/open-code-review-toolkit/releases) 中作为列有 checksum 且经过来源验证的资产进行镜像。开发快照仅发布到 TestPyPI。
## GitLab CI 快速入门
1. 在 GitLab 中配置受保护/隐藏的 `GITLAB_API_TOKEN` 和 LLM 变量。
2. 锁定 OCR 二进制文件并验证 checksum。
3. 安装此包。
4. 在 `ocr review` 周围运行五个辅助阶段:
```
ocr-ci preflight
ocr-ci configure
ocr-ci mcp-config
ocr-ci context --output .review-context/dependencies.md
# 运行:ocr review ... --format json
ocr-ci post --result /tmp/ocr-result.json --stderr /tmp/ocr-stderr.log
```
请参阅完全合成的 [`examples/gitlab/ocr-review.gitlab-ci.yml`](examples/gitlab/ocr-review.gitlab-ci.yml) 和 [GitLab 指南](docs/gitlab.md)。
## 配置与安全
在 v0.1 版本中,配置仅支持环境变量。[配置参考](docs/configuration.md) 记录了支持的 `OCR_*`、`CI_*`、`GITLAB_*` 和 MCP 输入。发布操作需要 `GITLAB_API_TOKEN`;有意不支持 job token 和遗留别名。
仓库内容、OCR 输出和 provider 响应均属于不受信任的输入。该工具包采用有界读写、secret 脱敏、Unicode 规范化、Markdown/quick-action 中和、带有指纹的 comment、人工回复的所有权边界以及回滚控制。在启用写访问权限之前,请审查[安全与信任模型](docs/security.md)。
## 开发与发布
- [贡献指南](CONTRIBUTING.md)
- [开发指南](docs/development.md)
- [安全策略](SECURITY.md)
- [发布流程](docs/release.md)
- [更新日志](CHANGELOG.md)
基于 Apache-2.0 许可。
标签:GitLab CI, Python, 代码审查, 开源框架, 持续集成, 无后门, 逆向工具