Rate this page:
Configuration as code (config-as-code) is an automated method of maintaining Compass component data in a Git repository. You can choose to declare component details in a YAML file that sits alongside the source code for the component itself. Learn more about how config-as-code works
With config-as-code, you can take an existing Compass component and move its source of truth to a YAML configuration file in your code repository. Once you connect the component with your repository, update the component's data by updating the YAML configuration file. Any updates to the YAML file on your repository’s default branch automatically sync back to Compass and reflect in Compass.
In this way, you can use the same version control practices for maintaining component data as you use for the rest of your codebase.
Compass currently supports config-as-code with Bitbucket Cloud and GitHub.
Here’s how config-as-code works:
compass.yml
. Each component has its own compass.yml
file. Learn more about the structure and contents of a compass.yml filecompass.yml
file in a repository in your source code provider. Learn how to manage components with config-as-code
compass.yml
files in separate subfolders anywhere in your repository structure.compass.yml
file in your repository becomes the source of truth for all the component’s details.
compass.yml file
, not via the Compass UI or API.compass.yml
file. Learn how to update a component managed via config-as-codeRate this page: