Introducing the EventCatalog GitHub Action

Today we are excited to announce the release of the EventCatalog GitHub Action. This action is a powerful tool that helps you catch issues early in your pull requests, ensuring your event-driven architecture stays healthy, aligned and governed.

What is the EventCatalog GitHub Action?

The EventCatalog GitHub Action is a GitHub Action that helps you catch issues early in your pull requests. You can pick which tasks you want to use from the Action from your pull requests.

The EventCatalog Action has the context of your EventCatalog, and can help you identify issues with producers, consumers, messages and much more.

Get started with the EventCatalog GitHub Action

The EventCatalog GitHub Action brings AI-powered insight into your Git workflows. It uses large language models (LLMs) to automatically review changes to your EventCatalog, helping you catch issues early—before they reach production.

Think of it as a smart assistant for your pull requests. It doesn't just lint code—it understands the implications of your changes.

What it does:

• Detect breaking changes in schemas during pull requests
• Score how likely a change is to cause issues
• List affected consumers so you know who’s impacted
• Recommend actions to resolve problems before merging

By automating the review process, this GitHub Action saves your team hours of manual effort, reduces human error, and brings consistency to your EventCatalog maintenance.

You’re always in control—the final merge decision is still up to you. But now, you’ll have the insights to make it with confidence.

What are tasks?

Tasks are the core of the EventCatalog GitHub Action. They are a range of tools you can use.

With this initial version we are launching the Schema Review task.

We will be adding more tasks in the future.

How does the schema review task work?

The schema review task is used to review schemas for breaking changes. This task let's you catch breaking changes in your schemas before they are deployed.

The schema review supports any schema format, including (JSON, Avro, Protobuf, Thrift, etc.).

Why use the schema review task?

• Capture breaking changes in your schemas before they are deployed
• Get a score of how likely the changes are to be breaking
• See a list of consumers that will be affected by the changes
• Take action to fix breaking changes before they are deployed

Workflow example:

1. Your team member makes a change to a schema in EventCatalog (inside your events, queries or commands folders)
2. The action will review the schema for breaking changes using your configured LLM (OpenAI, Anthropic, Google)
3. The action will return a summary of changes, and give you a score of how likely the changes are to be breaking
4. The action will list affected consumers so you know who’s impacted
5. Your team member is still in control of the merge decision, but now has the information to make a more informed decision

How to get started?

To get started you can read our quick guide in our documentation here.

The EventCatalog GitHub Action uses LLMs to review your schemas, and find breaking changes. You can pick your provider and model from the following list:

• OpenAI
• Anthropic
• Google

Summary

The EventCatalog GitHub Action is a powerful tool that helps you catch issues early in your pull requests, ensuring your event-driven architecture stays healthy, aligned and governed.

Finding breaking schemas early can save you time and de-risk your production environment.

To get started you can read our quick guide in our documentation here.

FAQ

• What is the EventCatalog GitHub Action?

  • The EventCatalog GitHub Action is a GitHub Action that helps you catch issues early in your pull requests. You can pick which tasks you want to use from the Action from your pull requests.

• Will the LLM hallucinate?

  • Like all LLMs, the EventCatalog GitHub Action can hallucinate, although we provide the right context to the LLM to help it understand the context of the changes and the effected consumers.
  • You have configuration to pick which provider and models you want to use. If you are seeing hallucinations, you can try a different provider or model.
  • Think of EventCatalog GitHub Action as another member of your team. It is not a replacement for your team, but a tool to help you catch issues early, saving you time.

• Can I bring my own rules?

  • We are working on it!
  • We want you to to have the ability to bring your own rules to the action. This will let you define your own rules for your organization and health checks for the LLM.
  • This will let you define specific rules for your organization and governance checks for the LLM to check for your reviews.