Rate this page:
GitHub is a Git-based code hosting and collaboration tool, built for teams.
Compass currently supports GitHub as a tool to:
To integrate Compass with GitHub, you must first install the GitHub app in Compass. Then, you connect Compass to the Github organization that contains the repositories from where you want to manage the component.
You can connect only one GitHub organization to a Compass instance.
To integrate Compass with GitHub:
Now you can manage components from the repositories within the connected GitHub organization by setting up configuration as code (config-as-code) for your components. Learn how to manage components via config-as-code
Personal GitHub user accounts can’t be connected to Compass. This app can only be installed for GitHub organizations and enterprise accounts.
Compass’s integration with a GitHub organization lets you manage your components with configuration as code (config-as-code) by using GitHub as a component management tool. However, if you want to configure a different workspace or no longer want to use config-as-code, you can disconnect your current GitHub organization from Compass.
Once you disconnect a GitHub organization, any managed components in Compass are disconnected and will no longer be synced with GitHub. Don’t worry, the components remain in Compass and you can manage them via the Compass UI.
To disconnect a GitHub organization from Compass:
Now you can manage the components previously managed via config-as-code from the Compass UI. You can also configure a different GitHub organization.
If you no longer want to use GitHub as a component management tool, you can uninstall the GitHub app from Compass.
Once you uninstall the GitHub app, any managed components in Compass are disconnected and will no longer be synced with GitHub. Don’t worry, the components remain in Compass and you can manage them via the Compass UI.
To uninstall the GitHub app from Compass:
Now your GitHub-managed components will no longer be managed by any existing compass.yml files and can be modified and updated via the Compass UI. At any time, you can again integrate Compass with GitHub to set up config-as-code for component management.
Rate this page: