All Collections
Catalog best practices
Managing Catalog Types in GitHub
Managing Catalog Types in GitHub Engineering Team avatar
Written by Engineering Team
Updated over a week ago

This feature is useful when you want to version control catalog types you've created in the dashboard.

This feature will generate all the files you need, and configure GitHub to automatically sync changes you make from the repository to the catalog in

Once you've configured a catalog type to be managed in GitHub, you'll no longer be able to edit it through the dashboard.

Can I use it?

If you have access to custom types in the catalog, you can also use the manage in GitHub feature.

How do I use it?

On the catalog homepage, above your custom types, there's a "Manage in GitHub" button. Clicking it will take you through the process of configuring one or more catalog types to be managed in GitHub.

How do I change catalog types once they're managed in GitHub?

To change catalog types, edit the jsonnet files in your repository and open a pull request.

A GitHub action will run and show you the changes that will be made to the catalog.

If you're happy with the changes, merge the pull request and another action will run and sync the change to your catalog.

How does it work?

Under the hood, this feature uses our catalog importer. This is a flexible tool for syncing external data in to the catalog. If you're looking to do more complex things with external data in the catalog, the examples included with the catalog importer are a great place to start.

Did this answer your question?