Skip to main content
OpenWiki can refresh repository documentation on a schedule and open a pull request or merge request when the wiki changes. Example workflows ship in the OpenWiki repository.

​
Add a workflow

Copy the example for your Git provider:

​
Run update in CI

For repository documentation in CI, use:
You do not need to run --init in CI. --update creates the initial openwiki/ docs if they do not exist yet, as long as the workflow provides the required provider and model environment variables. Provide credentials as repository secrets or CI variables. Typical values include:
  • Provider API key (or Copilot OAuth token / cloud credentials for keyless providers)
  • OPENWIKI_PROVIDER
  • OPENWIKI_MODEL_ID
  • Optional LANGSMITH_API_KEY for tracing
The scheduled workflow includes generated wiki files, AGENTS.md, CLAUDE.md, and the workflow itself in the documentation pull request when those files change.

​
Empty updates

OpenWiki automatically tracks wiki content in openwiki/.last-update.json and only rewrites that file when the wiki actually changed. If a scheduled --update run does not result in changes, the wiki files stay the same, and the CI does not open a pull request.

​
Telemetry in CI

Scheduled and CI runs send anonymous reliability telemetry under a shared CI identifier. To disable telemetry in CI, set:
You can uncomment the corresponding line in the example workflow. To understand what is collected and how to opt out locally, see Customize OpenWiki.

​
See also

Connect these docs to Claude, VSCode, and more via MCP for real-time answers.
Edit this page on GitHub or file an issue.