event-catalog/EventCatalog Agents
AI agents that keep your EventCatalog documentation in sync with your code. Runs in CI as a GitHub Action.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 7, 2026
- License
- None
Pinned Snippet
uses: event-catalog/agents@ed544eb00da486c8f7ec227f92b2c947186f8012 # no releases — HEAD as of 2026-07-11tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| catalog-repo | EventCatalog repository to check out, in owner/repo format. | yes | — |
| catalog-ref | Branch to check out from the EventCatalog repository and target with documentation pull requests. | no | main |
| catalog-token | Optional token used to check out the EventCatalog repository. Defaults to github.token. | no | — |
| catalog-url | Optional URL of your hosted EventCatalog. When provided, breaking-changes comments link affected resources and owners to the catalog. | no | — |
| model | Model specifier for the documentation agent. See available models: https://pi.dev/models | no | anthropic/claude-sonnet-4-6 |
| ignore-paths | Comma-separated paths or glob patterns to ignore when collecting pull request changed files. | no | node_modules,dist,build,coverage,.next,.nuxt,.output,.svelte-kit,.astro,.turbo,.cache,.vite,.vercel,.netlify,out,target,bin,obj,vendor |
| agent | Which agent to run on each pull request. Available: code-to-docs, breaking-changes. | no | code-to-docs |
| schema-extensions | Comma-separated file extensions the breaking-changes agent treats as message schemas. Add others (e.g. .js) to match where your contracts live. | no | .json,.yml,.yaml,.avro,.avsc,.proto,.graphql,.gql |
Outputs
no outputs