performance-report

README

performance-report

Creates a performance report using the GitLab API, comparing metrics against peers and superiors.

The results will be printed in human-readable format (example below).

It will also create a .csv file for each statistic in a local directory called results.

Example report

Human-readable terminal output

Below is an example report with numbers randomly generated:

Contributions per month
        peers:          XXX
        j.doe:          YYY
        superiors:      ZZZ
Merge requests per month
        peers:          XX
        j.doe:          YY
        superiors:      ZZ
Reviews per month
        peers:          XX
        j.doe:          YY
        superiors:      ZZ

CSV reports

Below is the content of the results/ directory after the report has run:

$ tree ./results
./results
├── Contributions_per_month.csv
├── Merge_requests_per_month.csv
└── Reviews_per_month.csv

0 directories, 3 files

Usage

1. Create a file named config.yaml with the following content:

   username: "your_username"
   start_date: "YYYY-DD-MM"
   peer_usernames:
     - engineer1
     - engineer2
     - ...
   superior_usernames:
     - seniorEngineer1
     - seniorEngineer2
     - ...
   team_project_ids:
     - 12345 # https://gitlab.com/group/project1
     - 67890 # https://gitlab.com/group/project2
     - ...
   

2. Run the report in the same directory as the files above:

   docker run --rm \
     -v $(pwd)/config.yaml:/run/config.yaml \
     -v $(pwd)/results:/run/results \
     registry.gitlab.com/mnielsen/performance-report:latest
   

Report icon by Icons8