GitHub Repo Stats

A GitHub Action (in Marketplace) built to overcome the 14-day limitation of GitHub's built-in traffic statistics.

Data that you don't persist today will be gone in two weeks from now.

High-level method description:

• This GitHub Action runs once per day. Each run yields a snapshot of repository traffic statistics (influenced by the past 14 days). Snapshots are persisted via git.
• Each run performs data analysis on all individual snapshots and generates a report from the aggregate — covering an arbitrarily long time frame.

Looking for a quick start? Follow the simple tutorial in the Wiki.

Highlights

The report is generated in two document formats: HTML and PDF. The HTML report resembles how GitHub renders Markdown and is meant to be exposed via GitHub pages. Charts are based on Altair/Vega. The PDF report contains vector graphics. Data updates, aggregation results, and report files are stored in the git repository that you install this Action in: this Action commits changes to a special branch. No cloud storage or database needed. As a result, you have complete and transparent history for data updates and reports, with clear commit messages, in a single place. The observed repository (the one to build the report for) can be different from the repository you install this Action in. The HTML report can be served right away via GitHub pages (that is how the demo above works). Careful data analysis: there are a number of traps (example) when aggregating data based on what the GitHub Traffic API returns. This project tries to not fall for them. One goal of this project is to perform advanced analysis where possible.