Last updated Jan 5, 2022

Rate this page:

View a component's deployment activity

The activity feed in Compass displays deployment events from your component’s connected Bitbucket repository. It helps you assess the recency of the production build and see the frequency of deployment activity right from within Compass.

A component’s activity feed can also show you the deployment events from your component's upstream dependencies, which are the components that your component depends on.

We’ll show you how to set up and view a component’s activity feed in Compass.

Set up the activity feed

Compass is able to display deployment events generated by your Bitbucket Pipelines. For these events to appear in Compass, you must first set up a few things for your component:

  1. Integrate Compass with Bitbucket Cloud
  2. Set up and configure Bitbucket Pipelines for the activity feed
  3. Add a repository link to a component

Once you complete the setup, the recent deployment events from Bitbucket appear in your component’s details page in Compass.

Integrate Compass with Bitbucket Cloud

If you’ve not already done so, install the Bitbucket app on your Compass site and connect Compass to your Bitbucket workspace. You need to perform this step only once before setting up the activity feed for all your components.

To integrate Compass with Bitbucket Cloud:

  1. Install the Bitbucket app in Compass. Select Apps from the top navigation and select Install on Bitbucket tile.
  2. Select Configure and connect Compass to the Bitbucket workspace containing your component’s repositories.

Learn more about how to integrate Compass with Bitbucket Cloud

Set up and configure Bitbucket Pipelines for the activity feed

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:

  1. Set up a pipeline in your component’s repository.
  2. Configure the bitbucket-pipelines.yml file. Include the deployment: production keyword in the step section.
    • The deployment keyword sets the type of environment for your deployment step, and it is used in the Deployments dashboard in Bitbucket.
    • Currently, Compass can read deployment events only from production environments. So, Compass reads the events from the pipeline only where the value of the deployment keyword is set to production.
    • Here’s an example of the step in a pipeline that generates deployment events, which Compass can read:
      1
      2
      3
      4
      5
      - step:
      name: Deploy to prod
      deployment: production
      script:
        - *deploy

Learn more about setting up and monitoring deployments in Bitbucket

Compass can read deployment events from a component’s connected repository having Bitbucket Pipelines configured. You can connect a repository to a component in Compass by adding the repository link to the component details page.

  • You can add links to any repositories from the Bitbucket workspace that is connected to your Compass site. The activity feed shows deployment events from all those repositories when you set up and configure Pipelines on them.

  • If you install and configure the Bitbucket app after adding a repository link to the component, the activity feed starts reading the deployment events from the connected repository, once your app configuration completes. The activity feed also backfills historical deployment events from the connected repository.

  • The activity feed does not read deployment events from any repositories that are not in the connected Bitbucket workspace.

To add a link to a component's repository:

  1. In Bitbucket, copy the link to your component’s repository.
  2. Go to your component’s details page in Compass.
  3. In the Overview tab of your component’s details page, add the link in the Repositories section.

Learn more about adding links a component's resources

View the deployment activity

A component's deployment activity appears in Compass only if you've set up the activity feed for the component and there is at least one deployment in your component’s production environment. The activity feed also shows a deployment events from a component's upstream dependencies if you've set up the activity feed for those components. The deployment events from your component appear alongside the deployment events from its dependencies.

To view the deployment activity:

  1. If you are not already there, go to your component’s details page in Compass.
  2. See the Latest deployment tag under the component’s name. Hover on the tag to view the details of the latest deployment. Latest deployment tag
  3. Select Activity from the left navigation to view your component’s recent deployment activity.
  4. Select Show dependencies to view the deployment events from your component’s upstream dependencies. Deployment activity list view with dependencies

Compass maps the states of deployment events from Bitbucket to specific statuses that appear in the deployment tag and activity list. Learn more about deployment statuses in the activity feed

Deployment statuses in the activity feed

Compass reads the states of the deployment events from Bitbucket and maps them to specific statuses to appear in a component’s deployment tag and activity list.

The following deployment statuses appear in Compass:

Deployment in progress icon In Progress

The deployment has started and is currently in progress. This is an intermittent status and it changes to show the most current status as the deployment progresses.

Deployment success icon Successful

The deployment was completed because it was successful.

Deployment canceled icon Canceled

The deployment was completed because a user stopped it while it was in progress.

Deployment failed icon Failed

The deployment was completed because it failed.

Deployment status unknown icon Unknown

The deployment event’s state isn’t available for Compass to read.

Rate this page: