主题
自动化更新
使用 GitHub Actions、GitLab CI 或 Bitbucket Pipelines 安排 OpenWiki 文档更新
OpenWiki 可以按计划刷新仓库文档,并在 wiki 发生变化时打开拉取请求或合并请求。示例工作流随 OpenWiki 仓库提供。
添加工作流
复制适用于你的 Git 服务商的示例:
| 服务商 | 示例 | 目标位置 |
|---|---|---|
| GitHub Actions | openwiki-update.yml | .github/workflows/openwiki-update.yml |
| GitLab CI | openwiki-update.gitlab-ci.yml | .gitlab-ci.yml,或从现有流水线中引入它 |
| Bitbucket Pipelines | openwiki-update.bitbucket-pipelines.yml | bitbucket-pipelines.yml,然后为 openwiki-update 自定义流水线安排计划 |
在 CI 中运行更新
对于 CI 中的仓库文档,请使用:
bash
openwiki code --update --print你无需在 CI 中运行 --init。只要工作流提供了所需的服务商和模型环境变量,--update 就会在 openwiki/ 文档尚不存在时创建它们。
以仓库机密或 CI 变量的形式提供凭据。典型值包括:
- 服务商 API 密钥(或用于无密钥服务商的 Copilot OAuth token / 云凭据)
OPENWIKI_PROVIDEROPENWIKI_MODEL_ID- 可选的
LANGSMITH_API_KEY,用于追踪 - 当仓库使用 LangSmith 连接器时,可选的
OPENWIKI_LANGSMITH_API_KEY
当这些文件发生变化时,计划工作流会将被生成的 wiki 文件、openwiki/.claims/ 下的 Claims、AGENTS.md、CLAUDE.md 以及工作流本身包含在文档拉取请求中。
在持久化工作区上,仓库生成可通过 openwiki/.run.json 和 openwiki/.page-manifest.json 断点续传。临时性的 CI 运行器在失败后会从头开始,除非其工作区被保留;而当一次运行在某些页面完成后失败时,OpenWiki 仍可发布部分进度。
空更新
一次无变化的 --update 运行会跳过模型工作,保持 wiki 内容不变,同时刷新 openwiki/.last-update.json,以便新鲜度检查反映出该检查已运行。如果 wiki 的 Markdown 和 Claims 未发生变化,CI 不会打开拉取请求。
CI 中的遥测
计划运行和 CI 运行会在共享的 CI 标识符下发送匿名可靠性遥测。要在 CI 中禁用遥测,请设置:
bash
OPENWIKI_TELEMETRY_DISABLED=1你可以在示例工作流中取消注释相应的行。要了解收集了什么以及如何在本地选择退出,参见自定义 OpenWiki。