Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

264 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The Reponomics Dashboard Project

GitHub License GitHub Release GitHub Release Date GitHub commits since latest release

CI Vendored assets Runtime lock Scorecard supply-chain security SHA pinning Immutable releases OpenSSF Best Practices

CodeQL Dependabot Updates Dependency Graph OSV SARIF scan

Note

The Reponomics Dashboard is being developed in public, but is not ready for general public use as of yet. If you are interested in the project, and would like to contribute, or join our beta group of early adopters, you can find more information below.

The goal of this project is to provide GitHub project maintainers with an easy way to collect data about their projects across GitHub, store it safely and privately in a centralized location, provide a first-class analytics dashboard for viewing that data, and to do all of that for no additional cost, with no signup, no trackers, no third-party services, using only the resources that GitHub already provides to every maintainer.

The project consists of a template repository that anyone can copy, and a GitHub action that handles the core functionality such as querying the GitHub API for repository data, storing the data in CSV format in workflow artifacts, and rendering and publishing the data directly to GitHub Pages. In order to allow owners to view their HTML data dashboards, which contain private information about their repos, on GitHub Pages, which are in general open to the public at large, we use cryptography to encrypt the data as soon as it is collected, it is served to the Pages site in encrypted form, and the software only ever decrypts the data from within the browser, on the client side. The software is designed so that if the user/owner creates a high-entropy encryption key, according to the methods we recommend, then offline brute-force attack is infeasible.

Warning

The privay and security model provided by the Reponomics Dashboard Action depends entirely on the user/owner's own encryption secret - the action does not check the strength or entropy level of that secret - although we do give you some resources you can use to do so - and the reader should be aware that keys generated by any method besides the ones that we describe (or known to be equally reliable) offer little to no privacy at all.

In addition to providing repository analytics, the Dashboard is a place for maintainers to gain insight into the overall health of their various projects, and to access materials that might help them grow their projects and attract more users. This includes guidance about repository maintenance, security best practices, and documentation. These resources are not gateways into a private commercial service offered by Reponomics - for the most part, they consist of official GitHub documentation, brought together into one place, and curated based on the specific context of your projects.

The Reponomics Dashboard is not a service. We don't make any promises - because we don't have to. We build open-source software, and everything we produce is independently auditable and verifiable through standard OSS supply chain security best practices. Each dashboard repo is owned by the person who copies the template, and Reponomics has no direct interactions with your data.

Interested?

If you are interested in contributing to this project, or you would like to join our informal beta/early-adopter group, you are encouraged to reach out to dashboard-beta@reponomics.org and we would love to have your feedback. Of course, all of this is open-source, and you are free to do whatever you want with this software without any special invitation - however, we do not currently recommend it, and there may be breaking changes. The point of the beta period is simply that the software itself is also "beta" - it may have some rough edges, and people who have explicitly expressed interest in participating will have a great impact on refining the product, as well enjoying a "priority lane" for any bug-fixes or requested enhancements. If it's any comfort, the part of the project that we believe has matured beyond beta (and if it weren't we would not be making it publicly available to anyone) is the privacy/security model.

About

Development repository for the Reponomics Dashboard project. Handles data collection, artifact storage, analytics, encryption, and rendering of HTML dashboard for Reponomics Dashboard template consumers

Resources

Code of conduct

Contributing

Security policy

Stars

2 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages