Event changelogs
EventCatalog supports changelogs for domains, services and messages.
When you version a event in EventCatalog, you can also attach a changelog.md
to that event or versioned event.
Adding a changelog
- Add a
changelog.md
to your event (or versioned event)- example
/events/{Event}/changelog.md
- versioned example
/events/{Event}/versioned/1.0.0/changelog.md
- example
Example
---
createdAt: 2024-08-01
badges:
- content: ⭐️ JSON Schema
backgroundColor: purple
textColor: purple
---
### Added support for JSON Schema
InventoryAdjusted uses Avro but now also supports JSON Draft 7.
```json title="Employee JSON Draft"
// labeled-line-markers.jsx
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Employee",
"properties": {
"Name": {
"type": "string"
},
"Age": {
"type": "integer"
},
"Town": {
"type": "string"
}
},
"required": ["Name", "Age", "Town"]
}
``
Navigate to your change log page for your event (example /docs/events/InventoryAdjusted/1.0.0/changelog) or click on the Changelog button on your event page.
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 event and also be used for auditing purposes.
Changelogs are visualized by EventCatalog.