Collecting GitHub stats for team updates

Topics

Training Team reps include some team statistics in each month’s Team Updates post. These statistics are calculated from publicly available GitHubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ data.

Learning Pathways content creation progress

Learning Pathways progress is tracked in the Learning Pathways Project GitHub project board. The Content Creation column includes an issue tracking the progress of each of the pathways’ content creation. See the progress listed at the top of a issue to see how many pieces of content have been completed.

Red arrow pointing at the progress listed at the top of a GitHub issue.

Top ↑

Learn GitHub repository stats

The team uses an open source tool called Cauldron to calculate these stats. Anyone can follow these steps to view these statistics.

Top ↑

Create your own report (do this once)

  1. Open https://cauldron.io/.
  2. Select Login (top-right) and sign in with your GitHub account.
  3. Once logged in, you’ll be asked to authorize Cauldron to access public information in your GitHub account. Click Authorize cauldron.
  4. Open this report template.
  5. Select Fork report, shown in the center of the screen next to the report name.
  6. Bookmark this report for your future reference.

Top ↑

Collect statistics

  1. Open your forked report.
  2. Cauldron requires the user to manually sync the report with current data on GitHub. To do this, click the sync report prompt shown on the report overview page.
    • The prompt only shows once every month or so. To manually trigger a sync, go to Settings (cogwheel in left sidebar > Actions and select Rerun all actions.
Screenshot of Cauldron settings screen with red arrows highlighting the "Rerun all actions" button.
  1. Return to the report overview and wait for the syncing to complete.
    • You’ll see a message on the screen while a sync is in progress.
  2. Adjust the time filterFilter Filters are one of the two types of Hooks https://codex.wordpress.org/Plugin_API/Hooks. They provide a way for functions to modify data of other functions. They are the counterpart to Actions. Unlike Actions, filters are meant to work in an isolated manner, and should never have side effects such as affecting global variables and output. in the top-right to the desired timeframe.
  3. Select Activity > Overview to see statistics regarding issues and pull requests.
  4. Select Community > Overview to see statistics regarding active members on the repository.

Last updated: