How to setup a DevLake project

Prerequisites

• Devlake has successfully integrated with JIRA
• Devlake has successfully integrated with Gitlab

Introduction

• On a high level, a DevLake project can be viewed as a real-world project or product line. It represents a specific initiative or endeavor within the software development domain

• On a lower level, a DevLake project is a way of organizing and grouping data from different domains

Create Devlake Project

Step 1. Go to Devlake Admin dashboard. In Project tab, click to New Project button

Step 2. Create Devlake project

• Enter Project Name and Enable DORA Metrics. Click Save

• A new project will show at Projects dashboard

Add JIRA data connection

Step 1. Now we setup Data Connections for JIRA. Click to Project Setting button

Step 2. Click to Add a Connection button

Step 3. Choose Connections associated with project. Click Next

Step 4. Add data scope (JIRA Boards). Click Save

Note: If there no Data Scope appears, you must add Data Scope (JIRA Board) in Devlake JIRA Connection settings. Please read this doc for further instructions.

Step 5. A new connecton will show in Project Configuration tab. Click Collect Data button so Devlake can fetch data from JIRA source

• In tab status, we will see Devlake Pipeline running

• After fetching done, you can visit dashboard to view metrics.

Add Gitlab data connection

Step 1. Choose Connections associated with project. Click Next

Step 2. Add data scope (Gitlab project). Click Save

Note: If there no Data Scope appears, you must add Data Scope (Gitlab Repository) in Devlake Gitlab Connection settings. Please read this doc for further instructions.

Step 3. A new connecton will show in Project Configuration tab. Click Collect Data button so Devlake can fetch data from JIRA source

• In tab status, we will see Devlake Pipeline running.

• After fetching done, you can visit dashboard to view metrics.

Setup sync policy

Step 1. Go to Project Configuration setting -> Sync Policy

Step 2. Setup sync policy for your project. Click Save

There are three settings for Sync Policy:

• Data Time Range: You can select the time range of the data you wish to collect. The default is set to the past six months.
• Sync Frequency: You can choose how often you would like to sync your data in this step by selecting a sync frequency option or entering a cron code to specify your prefered schedule.
• Skip Failed Tasks: sometime a few tasks may fail in a long pipeline; you can choose to skip them to avoid spending more time in running the pipeline all over again.