README.md

Atlassian Compass EventCatalog Generator

This generator can be used to create services in Event Catalog from an Atlassian Compass file.

Getting started

Installation and configuration

Make sure you are on the latest version of EventCatalog.

1. Install the package

   npm install -g @ismaelmartinez/generator-atlassian-compass-event-catalog

2. Configure your EventCatalog to use your generator

   Edit your eventcatalog.config.js file and add the generator

   ...
   generators: [
       [
           "@ismaelmartinez/generator-atlassian-compass-event-catalog",
           // These are options to give your generator
           {
               services: [
                   {
                       path: ["path/to/your/compass/file"],
                       version: "1.0.0" //Optional (defaults to 0.0.0)
                       id: "your-service-id" //Optional (defaults to the `name` in the compass file)
                   }, // Repeat for each service
               ],
               compassUrl: "https://your.atlassian.compass.url",
               domain: { id: 'orders', name: 'Compass', version: '1.0.0' }, //Optional
               debug: false //Optional
           }
           // Repeat for each domain
       ]
   ]
   ...

   Example configuration file

   NOTE: If a domain is provided, the services will be added to it. If the domain does not exist, it will be created.

3. Generate your services

   On your EventCatalog project, run the generate command:

   npm run generate

4. And explore your services in your catalog:

   npm run dev

Features

Currently, the generator only supports generating services from an Atlassian Compass file.

By design, the links with name 'null' are ignored. This is to allow having the links to EventCatalog in the Compass file without having to worry to show the link in the EventCatalog Service page.

Found a problem?

Raise a GitHub issue on this project, or contact us on our Discord server.

License

See LICENSE.

Contributing

See the CONTRIBUTING.md file for more information.