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
Why should I sync a component?
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.
What tools can I use to manage synced components?
Compass currently supports config-as-code with Bitbucket Cloud and GitHub.
How does config as code work?
Here’s how config-as-code works:
To set up config-as-code, first install a source code provider app in Compass. Then designate a workspace/organization where your repositories are located.
You can designate one source code provider workspace/organization to one Compass instance.
You must be an admin of the workspace/organization as well as in Compass to set this up.