Command changelogs

EventCatalog supports changelogs for domains, services and messages.

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

Adding a changelog

1. Add a changelog.md to your command (or versioned command)
   • example /commands/{Command}/changelog.md
   • versioned example /commands/{Command}/versioned/1.0.0/changelog.md

Example

/docs/command/AdjustInventory/changelog.md

---
createdAt: 2024-07-11
badges:
    - content: New field
      backgroundColor: green
      textColor: green
---

### Added new field to schema

We added the new town property to the schema for downstream consumers. 

```json ins={"New: Added new Town property to schema:":9-10}
// labeled-line-markers.jsx
{
  "type" : "record",
  "namespace" : "AdjustInventory",
  "name" : "Employee",
  "fields" : [
     { "name" : "Name" , "type" : "string" },
     { "name" : "amount" , "type" : "int" },
     { "name" : "Town" , "type" : "string" },
  ]
}
``

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

Changelogs are visualized by EventCatalog.