DEV Community πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

Cover image for Automation to get Github repositories insights reports
Guillaume Falourd
Guillaume Falourd

Posted on

Automation to get Github repositories insights reports

In a day-to-day work with Developer Relations, you need to be able to extract metrics to evaluate what you do, on social networks or events πŸ”Ž πŸ“Š

Github may not be considered as a social network, but as I've been implementing and creating contents there too, I thought it could be interesting to monitor the engagement that shared repositories can generate.

To do this, I created an automation in Python using Ritchie CLI. This automation generates a report in .csv format with several insights about my public and private repositories πŸ•΅οΈ

Thinking about making it more practical, I also set up a workflow using Github Actions with a CRON to add new reports weekly and allow me to follow the evolution of my work.

The insights reports .csv file looks like the following one:

report-sample

Those files will be generated and stored on the proper Github repository.

Anyone can use it, just create a new repository based on this one: repositories-reports (with Fork or Clone) and add 2 secrets to the new repository:

The full automation implementation is in python and may be found here, where the main file is this one: https://github.com/GuillaumeFalourd/formulas-github/blob/master/github/get/insights/src/formula/formula.py

The Github Action workflow is this one: https://github.com/GuillaumeFalourd/repositories-reports/blob/main/.github/workflows/1-reports-generator.yml if you want to perform something similar on other repositories.

Let me know if you have any suggestion or feedback!

Top comments (0)

DEV runs on 100% open source code known as Forem.

Β 
Contribute to the codebase or host your own.
Β 
Check these out! πŸ‘‡