github-stats

# [GitHub Stats Visualization](https://github.com/jstrieb/github-stats)

<!--
https://github.community/t/support-theme-context-for-images-in-light-vs-dark-mode/147981/84
-->

<div align="center">
<a href="https://github.com/jstrieb/github-stats">
<img src="https://github.com/jstrieb/github-stats/blob/generated/overview.svg#gh-dark-mode-only" />
<img src="https://github.com/jstrieb/github-stats/blob/generated/languages.svg#gh-dark-mode-only" />
<img src="https://github.com/jstrieb/github-stats/blob/generated/overview.svg#gh-light-mode-only" />
<img src="https://github.com/jstrieb/github-stats/blob/generated/languages.svg#gh-light-mode-only" />
</a>
</div>

Generate visualizations of GitHub user and repository statistics with GitHub
Actions. Visualizations can include data from private repositories, and from
repositories you have contributed to, but do not own.

Generated images automatically switch between GitHub light theme and GitHub
dark theme.


## Background

When someone views a GitHub profile, it is often because they are curious about
the user's open-source contributions. Unfortunately, that user's stars, forks,
and pinned repositories do not necessarily reflect the contributions they make
to private repositories. The data likewise does not present a complete picture
of the user's total contributions beyond the current year.

This project aims to collect a variety of profile and repository statistics
using the GitHub API. It then generates images that can be displayed in
repository READMEs, or in a user's [Profile
README](https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme).
It also dumps all statistics to a JSON file that can be used for further data
analysis.

Since this project runs on GitHub Actions, no server is required to regularly
regenerate the images with updated statistics. Likewise, since the user runs the
analysis code themselves via GitHub Actions, they can use their GitHub access
token to collect statistics on private repositories that an external service
would be unable to access.


## Disclaimer

The GitHub statistics API returns inaccurate results in some situations:

- Total lines of code modified may be too high or too low
  - GitHub counts changes to files like `package-lock.json` that may inflate the
    line count in surprising ways
  - On the other hand, GitHub refuses to count lines of code for repositories
    with more than 10,000 commits, so contributions to those will not be
    reflected in the data at all
  - [The GitHub API endpoint for computing contributor statistics no longer
    works reliably](https://github.com/orgs/community/discussions/192970), so we
    fall back on computing the statistics ourselves by cloning each repository
    locally and tallying lines changed with the `git` CLI
    - Our computed totals likely under-count relative to GitHub's, since theirs
      correctly attribute authorship for contributions to pull requests with
      s