Skip to main content

Understanding changelogs

In event-driven architectures, various components like domains, services, schemas, formats, and boundaries are constantly evolving. Unfortunately, the context or reason behind these changes often gets lost.

EventCatalog changelogs allow you to capture these changes and help your team understand the history of your architecture.

Features​

  • Powered by markdown, add a changelog.md to your domains, services and messages
  • Automated diffs for .json, .avro, .yml and .yaml files.
  • Custom components and MDX component support
  • Timestamps and linear history on page

Example​

Example

You can see a changelog example here.