使用插件调用 AI 大模型(LLM)为仓库生成 Wiki 文档。
cnbcool/codewiki
git_doc_dir:必填。指定 codewiki 生成文档的保存位置$:
tag_push:
- stages:
- name: 生成 Code Wiki
timeout: 4h
image: cnbcool/codewiki:latest
settings:
git_doc_dir: /${CNB_BUILD_WORKSPACE}/${CNB_REPO_SLUG}/codewiki
| 字段名 | 说明 | 备注 |
|---|---|---|
| timeout | 设置单个任务的超时时间,默认为 1 小时。仓库比较大时,codewiki 生成时间可能超过 1 小时。 | 设置单个任务超时时间 |
CNB_BUILD_WORKSPACE和CNB_REPO_SLUG是 CNB 流水线内置的默认环境变量。更多环境变量请参考
$:
tag_push:
- services:
- docker
docker:
volumes:
- /data/codewiki/${CNB_REPO_SLUG}:data
stages:
- name: 生成 Code Wiki
timeout: 4h
image: cnbcool/codewiki:latest
settings:
git_doc_dir: /data/codewiki/${CNB_REPO_SLUG}
| 字段名 | 说明 | 备注 |
|---|---|---|
| volumes | 挂载目录,临时存储生成的 codewiki 文档。:data 表示创建一个临时数据卷,该数据卷在流水线结束时会自动清理。 | 声明数据卷 |
建议使用 tag_push 事件,避免频繁生成 wiki 文档。