Skip to main content

Service changelogs

EventCatalog supports changelogs for domains, services and messages.

When you version a service 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 service (or versioned service)
    • example /services/{Service}/changelog.md
    • versioned example /services/{Service}/versioned/1.0.0/changelog.md

Example

/docs/services/PaymentService/changelog.md
---
createdAt: 2024-08-01
badges:
    - content: New event published
      backgroundColor: green
      textColor: green
---

### Service now publishes a new event

The PaymentService now publishes a new event called `PaymentAccepted`

Navigate to your change log page for your service (example /docs/services/PaymentService/0.0.1/changelog) or click on the Changelog button on your service 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 service and also be used for auditing purposes.

Changelogs are visualized by EventCatalog.