Overview
The GitLab data connector for WorkBoard enables you to select DORA metrics or a count of issues based on custom filters. Issues can be filtered based on key properties like Project, Status, Date and Labels.
DORA Metrics allow users to pull data based on key performance metrics of a dev team such as Change Failure Rate, and Deployment Frequency. As issue statuses and DORA metrics are updated in GitLab, changes will be reflected in WorkBoard based on the next update cadence.
Requirements
- The IT admin for your organization may need to approve the connector for the first time if the App is configured to require approval.
Add an GitLab Key Result
- Hover over your Objective and click the Kebab.
- Select Edit Settings.
- Select Add another Key Result.
- Select Advanced Options.
- Choose Pull data from external applications.
- Pick GitLab from the list of integrations.
- Sign in using your GitLab credentials or through SSO.
- Select whether issues should be specified using the Query builder or Dora metrics.
For issues specified using Query builder:
- Select a project or group.
- Optional: Use the dropdown selections to add additional filters on your selected project including milestones, iterations, labels, and assignees.
- Select the timeframe by which to filter issues by certain due dates. If selecting a Custom timeframe, select the date range of your choice.
If selecting a Custom timeframe, select the date range of your choice. - Select how progress should be calculated.
Note: Sum of weights of completed issues is only available for Premium GitHub users.
- (Optional) For real-time validation of data before connecting, select Preview results.
- Choose Connect to set up GitLab integration.
- Fill out or edit the remaining Key Result details such as Start Value, Result Value, Target Value, Committed Result, Unit of Measurement and how to Calculate Overall Progress.
- Choose your Update Cadence, which determines when or how often WorkBoard will sync with GitLab to pull the latest value for your Key Result.
- Note: Update cadence has the same options you would find for Key Results updated by a person (i.e., Daily, Weekly, Monthly, and Quarterly).
9. Select Save.
- Note: Update cadence has the same options you would find for Key Results updated by a person (i.e., Daily, Weekly, Monthly, and Quarterly).
For issues specified using Dora metrics:
- Select a project or group.
- Select a metric from the dropdown menu.
- Select an environment tier from the dropdown menu.
- Select the timeframe by which to filter issues by certain due dates. If selecting a Custom timeframe, select the date range of your choice.
- Select how progress should be calculated.
Note: Sum of weights of completed issues and sum of weights completed of all issues are only available for Premium GitHub users.
- (Optional) For real-time validation of data before connecting, select Preview results.
- Choose Connect to set up GitLab integration.
- Fill out or edit the remaining Key Result details such as Start Value, Result Value, Target Value, Committed Result, Unit of Measurement and how to Calculate Overall Progress.
- Choose your Update Cadence, which determines when or how often WorkBoard will sync with GitLab to pull the latest value for your Key Result.
- Note: Update cadence has the same options you would find for Key Results updated by a person (i.e., Daily, Weekly, Monthly, and Quarterly).
- Select Save.
Synchronize Data from GitLab
WorkBoard will pull data for the KR directly from GitLab following the cadence specified. The Business Result Owner also has the ability to “sync data now” to pull data in real-time.
There are two ways to sync data for your Key Results.
Force a Sync on a Single GitLab Key Result:
- Select Key Result to go to the Key Results Details page.
- Choose the Kebab menu in the upper right-hand corner.
- Select Sync Integration Data.
Force a Sync for all Key Result Integrations:
- From the My Objectives Page, select the Kebab icon in the upper right-hand corner.
- Select Sync Integration Data.