Skip to main content

Service changelogs

Added in eventcatalog@2.13.0

EventCatalog supports changelogs for domains, services, messages and channels.

When you version a channel in EventCatalog, you can also attach a changelog.md to that service or versioned service.

Adding a changelog​

  1. Add a changelog.md to your channel (or versioned channel)
    • example /channels/{Channel}/changelog.md
    • versioned example /channels/{Channel}/versioned/1.0.0/changelog.md

Example

/channels/OrdersChannel/changelog.md
---
createdAt: 2024-08-01
badges:
    - content: New channel created
      backgroundColor: green
      textColor: green
---

### Channel protocol update

The OrdersChannel now accepts messages using kafka.

Navigate to your change log page for your channel or click on the Changelog button on your channel page.

"What do add to your change log?"

Changelogs are just markdown files, this allows you to add anything you want (e.g code blocks, tables)

EventCatalog code blocks supports diffs, code labels which are great features for changelogs. You can read more here.

Why add changelogs?​

Changelogs can provide your team with the context behind the reasons and choices for changes within your channel and also be used for auditing purposes.

Changelogs are visualized by EventCatalog.