logo
4
3
Login
feat: 将插件发布到插件市场

CodeWiki 插件

使用插件调用 AI 大模型(LLM)为仓库生成 Wiki 文档。

了解 CodeWiki

插件详情

插件镜像名

cnbcool/codewiki

参数说明

  • git_doc_dir:必填。指定 codewiki 生成文档的保存位置

插件在 CNB 中使用

$: 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_WORKSPACECNB_REPO_SLUG 是 CNB 流水线内置的默认环境变量。更多环境变量请参考

与 docker 一起使用

$: 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 文档。