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
  • Optional OPENWIKI_LANGSMITH_API_KEY when the repository uses the LangSmith connector
The scheduled workflow includes generated wiki files, Claims under openwiki/.claims/, AGENTS.md, CLAUDE.md, and the workflow itself in the documentation pull request when those files change. Repository generation is resumable on persistent workspaces through openwiki/.run.json and openwiki/.page-manifest.json. Ephemeral CI runners start fresh after failure unless their workspace is preserved, and OpenWiki can still publish partial progress when a run fails after some pages complete.

​
Empty updates

A clean --update run skips model work and leaves wiki content untouched while refreshing openwiki/.last-update.json so freshness checks reflect that the check ran. If the wiki Markdown and Claims do not change, 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.