ayodejiayodele/github-developer-metrics

Dashboards and report templates for reporting developer-related metrics inspired by some popular developer productivity frameworks..

GitHub Developer Metrics - Copilot Impact

This repository contains dashboards and report templates for reporting developer-related metrics. The metrics are derived from data available within the GitHub platform, providing a comprehensive view of the development process.

Overview

The project uses Power BI for data visualization, showcasing metrics around commits, pull requests, and CI/CD workflow runs. It also includes metrics related to GitHub Copilot, comparing the before and after figures to showcase the impact and value of Copilot in the development process.

Structure

The repository is structured as follows:

• src/github.Dataset: This directory contains the dataset definitions and model for the metrics.
• src/github.Report: This directory contains the report definitions and configurations.
• api.github.com.pbids, github.pbit, src/github.pbip: These files are related to Power BI and are used for data visualization.

Setup

To use this report, you need to have Power BI Desktop installed or the Power BI online service.

There are two versions of the report available:

1. Copilot-only metrics - this report displays visualizations solely coming from Copilot billing and usage stats
2. Developer/Copilot metrics - this report displays better visualizations overlaying Copilot metrics over flow metrics such as pull requests, commits, workflows, etc. to indicate impact of Copilot on development work.

`Screenshots are available in the images directory

Copilot Only Metrics Setup

Download and open the Copilot Only Power BI template .pbit file in Power BI Desktop and connect to your GitHub data source.

Devloper Metrics + Copilot Metrics Setup

There are two options to use this:

Option 1 - Install the Power BI App from AppSource

You can install from the AppSource. This will launch the app installation wizard in the Power BI service, taking you through the setup questions.

Option 2 - Install the Power BI App from a template file

Download and open the Power BI template .pbit file in Power BI Desktop and connect to your GitHub data source.

After opening the .pbit file, Power BI will prompt you to enter the parameters defined in the template. Once you've entered the parameters, the report will load with your data. You can then customize the reports to suit your needs and consume locally. Alternatively, you can publish the report to your workspace in Power BI service.

What you need to begin

The report makes use of the following parameters:

Parameters
Name	OrganizationList
Description	Comma-separated list of GitHub organizations to report on
Type	Text
Required	True
>>>>>>
Name	GitHubAPI
Description	The endpoint prefix for the GitHub API
Type	Text
Required	True
Value	https://api.github.com

Authentication

Important

To connect to your GitHub data, the integration requires authentication and authorisation. For authentication, select Basic authentication and supply your username and password.

Authentication
Type	Basic
Username	provide your username
Password	provide your PAT token
Privacy Level	Organization

Authorization

Create a classic personal access token (PAT). For more information on how to create PATs, follow the GitHub documentation.

You will need to set up the following permissions and scopes:

Scope	Permissions
workflow
admin:org	read:org
user	read:user
	user:email
admin:enterprise	read:enterprise
copilot	manage_billing:copilot
project	read:project
repo	repo:status
	repo_deployment
	public_repoAccess public repositories
	repo:inviteAccess repository invitations
	security_events

Note

To read Copilot data, you need to be an organization admin.

Contributing

Contributions to this project are welcome. Please open an issue to discuss your proposed changes or submit a pull request.

License

This project is licensed under the terms of the MIT license.