Skip to main content

Data store changelogs

Added in eventcatalog@2.59.0

EventCatalog supports changelogs for domains, services, messages and data stores.

When you version a data store in EventCatalog, you can also attach a changelog.mdx to that data store or versioned data store.

Adding a changelog​

  1. Add a changelog.mdx to your data store (or versioned data store)
    • example /services/{Service Name}/containers/{DataStore}/changelog.mdx
    • versioned example /services/{Service Name}/containers/{DataStore}/versioned/1.0.0/changelog.mdx

Example

/docs/services/PaymentService/containers/PaymentDatabase/changelog.md
---
createdAt: 2024-08-01
badges:
    - content: New table added
      backgroundColor: green
      textColor: green
---

### New Table added to the PaymentDatabase

The PaymentDatabase now has a new table called `PaymentTransactions`.

<!-- Other details about the change here -->

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