docs: refresh README zh/en and archive previous idea

This commit is contained in:
2026-04-08 23:12:24 +08:00
parent 1aad1afb3b
commit d9eab0bebd
3 changed files with 198 additions and 16 deletions
+46 -16
View File
@@ -1,17 +1,38 @@
这是一个读取 Gitea PR,并将其内容整理为 LLM 友好的文档的项目。
# gitea-pr-review
主要输出两种格式:
> 中文文档(默认) | English: [README.en.md](./README.en.md)
1. `markdown`:直接面向 LLM 的可读文档,重点保留 review/comment/reply 内容
2. `json`:结构化输出,便于二次处理。
`gitea-pr-review` 用于读取 Gitea Pull Request,并整理为适合 LLM 消费的文档
使用:
## 功能
- 拉取单个 PR 的核心信息:标题、状态、分支、commit 列表、基础 diff stat
- 完整保留 review/comment/reply 原文
- 支持两种输出格式:
- `markdown`:适合直接喂给 LLM
- `json`:结构化输出,便于脚本二次处理
- 支持从已保存的 JSON 重新渲染 Markdown(无需再次请求 Gitea
## 安装
```bash
GITEA_PR_CLI_API_TOKEN=...
GITEA_PR_CLI_URL=https://gitea.com
GITEA_PR_CLI_REPO=Origami404/aaa
cargo build --release
# 可执行文件:target/release/gitea-pr-review
```
## 环境变量
`fetch` 子命令需要以下环境变量:
- `GITEA_PR_CLI_API_TOKEN`
- `GITEA_PR_CLI_URL`(例如 `https://gitea.com`
- `GITEA_PR_CLI_REPO`(例如 `Origami404/aaa`
## 用法
### 1) 从 Gitea 拉取 PRfetch
```bash
# 默认输出 markdown 到 stdout
gitea-pr-review fetch <pr-index>
@@ -19,17 +40,23 @@ gitea-pr-review fetch <pr-index>
gitea-pr-review fetch <pr-index> --format json
# 输出到文件
gitea-pr-review fetch <pr-index> --format json --out pr.json
gitea-pr-review fetch <pr-index> --out pr.md
gitea-pr-review fetch <pr-index> --format json --out pr.json
```
# 从已有 json 重新生成 markdown
### 2) 从 JSON 渲染 Markdownrender-md
```bash
# 输出到 stdout
gitea-pr-review render-md --in pr.json
# 输出到文件
gitea-pr-review render-md --in pr.json --out pr.md
```
返回的 markdown 结构大致如下:
## Markdown 输出结构(示例)
`````md
````md
# <repo> `#<pr-index>` <pr-title>
## Metadata
@@ -38,9 +65,7 @@ gitea-pr-review render-md --in pr.json --out pr.md
- <sha-short> <title> (<author>, <date>)
### Diff Stat
- files changed: <n>
- additions: <n>
- deletions: <n>
total: <files_changed> files, +<additions>, -<deletions>
- <file-path>: +<additions>, -<deletions>
## Review 1 (<review-state>)
@@ -58,4 +83,9 @@ gitea-pr-review render-md --in pr.json --out pr.md
```md
<原始回复正文>
```
`````
````
## 说明
- 默认输出到 `stdout`;仅在指定 `--out` 时写入文件。
- 当评论正文本身包含 Markdown / 代码块时,渲染器会自动处理 fence,避免破坏整体结构。