Rate this page:
Bitbucket Cloud is a Git-based code hosting and collaboration tool, built for teams.
Compass currently supports Bitbucket Cloud as a tool to:
We’ll show you how to integrate Compass with Bitbucket by installing and configuring the Bitbucket Cloud app in Compass.
To integrate Compass with Bitbucket Cloud, you must first install the Bitbucket app in Compass. Then, you connect Compass to your Bitbucket workspace that contains the repositories from where you want to manage the component.
When you integrate an app with Compass, other Compass users can view events and metrics data sent from the app to Compass, even if they don't have access to that data in the underlying app. For example, when you integrate Bitbucket with Compass, someone who doesn't have access to a repository can see the events and metrics related to that repository in Compass. The same applies to data sent from this app to Compass.
Ensure that you are an admin on:
To integrate Compass with Bitbucket Cloud:
Now you can manage components from repositories within the connected Bitbucket workspace(s) by setting up configuration as code (config-as-code) for your components. Learn how to manage components via config-as-code
The Bitbucket app for Compass collects events to display on the Compass activity feed and automatically calculate certain metrics for your components. The following events are collected when you connect a Bitbucket repository to your component:
|Deployment||Bitbucket Pipelines deployments for Production and Staging category environments only|
To connect a repository to your component after performing the Bitbucket integration steps above:
Events will begin to appear on the activity feed and metrics will begin to calculate on the component details page.
Take a note of these additional points:
Bitbucket Pipelines is an integrated CI/CD service built into Bitbucket that allows you to automatically build, test, and deploy your code based on a configuration file in your repository. Setting up and configuring a pipeline enables you to view a component’s deployment activity in Compass.
To set up and configure a pipeline for activity feed:
- step: name: 'Deploy to production' deployment: production trigger: 'manual' script: - echo "Deployed to production." - step: name: 'Deploy to prod-east' deployment: prod-east trigger: 'manual' script: - echo "Deployed to prod-east."
Compass’s integration with a Bitbucket workspace lets you manage your components with configuration as code (config-as-code) by using Bitbucket 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 Bitbucket workspace from Compass.
We'll show you how to disconnect a Bitbucket workspace from Compass.
Ensure that you are an admin on:
Once you disconnect a Bitbucket workspace, any managed components in Compass are disconnected and will no longer be synced with Bitbucket. Don’t worry, the components remain in Compass and you can manage them via the Compass UI.
To disconnect a Bitbucket workspace from Compass:
Now you can manage the components previously managed via config-as-code from multiple workspaces through the Compass UI. You can also configure multiple workspaces at once. Learn how to integrate Compass with Bitbucket Cloud and configure a workspace.
If you no longer wish to use Bitbucket as a component management tool, you can uninstall the Bitbucket app from Compass.
We'll show you how to uninstall the Bitbucket Cloud app.
Once you uninstall the Bitbucket Cloud app, any managed components in Compass are disconnected and will no longer be synced with Bitbucket. Don’t worry, the components remain in Compass and you can manage them via the Compass UI.
To uninstall the Bitbucket workspace from Compass:
Now you can manage components from multiple workspaces via the Compass UI. At any time, you can again integrate Compass with Bitbucket Cloud to set up config-as-code for component management.
The Bitbucket app for Compass supports the following metrics:
|Metric||Description||How it's calculated|
|Build Success Rate||The ratio of build events for this component that were successful compared to all build events (including failed, timed out, etc.). Only the last 25 build events are evaluated.||Build events on the default branch.|
|Build Time||The average amount of time it took for a build event to finish over the last ten successful build events.||Build events on the default branch.|
|Deployment Frequency||The weekly average of times a deployment event to production occurred in the previous four weeks.||Deployment events from Bitbucket Pipelines.|
|Deployment Time||The average amount of time it took for a deployment in the production environment to complete over the last 25 deployments.||Deployment events from Bitbucket Pipelines.|
|Open Pull Requests||The count of currently open pull requests for a component.||Pull requests for the default branch currently in the open state.|
|PR Cycle Time||How long it took on average for a Pull Request to go from ‘open’ to ‘merged’ over the last ten pull requests.||Pull request open and close events for the default branch.|
Once you have finished setting up the integration, you can import your repositories from Bitbucket into Compass as components. Simply select Create from the top navigation bar in Compass and then choose "Import components" to get started. Learn more about importing from Bitbucket here.
Rate this page: