Skip to main content

Creating changelogs

Changelogs are currently supported in domains, services and messages.

To add a changelog to your resources you need to create a changelog.md file.

  • /{resource}/{resource name}/changelog.md
    • example: /services/My Service/changelog.md
    • example for verion: /services/My Service/versioned/0.0.1/changelog.md

Example of changelogs for resources

/events/OrderPlaced/changelog.md
---
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"]
}

``

Viewing your changelog​

Domains, services and messages have a Changelog button. Clicking this button will take you to the changelog for that resource.

Example output

Domains, services and messages all have a changelog url.

See example changelog: https://demo.eventcatalog.dev/docs/events/InventoryAdjusted/1.0.1/changelog