GitHub

Overview

This plugin let's you pull and sync schemas from GitHub into EventCatalog, and keep them in sync with your documentation.

With EventCatalog you can add semantic meaning to your schemas, and optionally assign them to producers, consumers, domains and owners.

Core Features

The EventCatalog GitHub plugin can provide you with many features:

• 📃 Pull and sync your schemas from your GitHub repository to EventCatalog
• 📃 Keep your schemas in sync with your producers and consumers documentation
• 📃 Supports any schema format (e.g Avro, Protobuf, JSON)
• 📃 Import all schemas, or specific folders/files
• ⭐ Go beyond a schema. Add semantic meaning to your schemas, business logic and much more. Help your developers and teams understand the meaning behind the schemas with clear documentation and visualisations.
• 📊 Visualise producers and consumers in your architecture (demo)
• ⭐ Download synced schemas from EventCatalog (e.g Avro, Protobuf, JSON) (demo)
• 📃 Assign schemas to events, commands and queries
• ⭐ Discoverability feature (search, filter and more) (demo)
• ⭐ And much more...

Examples

You can view our examples of this plugin on GitHub:

• Basic Example
  • Pull schemas and sync from GitHub into events, commands and queries in EventCatalog.
• Map schemas to producers and consumers
  • In this example we map schemas from GitHub to producers and consumers. Schemas are kept in sync whilst letting us document our architecture.