A GitHub Action to generate a report that contains various metrics for all repositories belonging to a GitHub organization.

The example workflow below runs on a monthly schedule using the amount of days counted from today set as the interval in the workflow (default 30 days) but can also be triggered manually using a workflow_dispatch input using a historic interval as dispatch inputs.

name: Org Repo Metrics Report

on:
  schedule:
    # Runs on the first day of the month at 00:00 UTC
    #
    #        ┌────────────── minute
    #        │ ┌──────────── hour
    #        │ │ ┌────────── day (month)
    #        │ │ │ ┌──────── month
    #        │ │ │ │ ┌────── day (week)
    - cron: '0 0 1 * *'
  workflow_dispatch:
    inputs:
      fromdate:
        description: 'Optional interval start date (format: yyyy-mm-dd)'
        required: false # Skipped if workflow dispatch input is not provided
      todate:
        description: 'Optional interval end date (format: yyyy-mm-dd)'
        required: false # Skipped if workflow dispatch input is not provided

jobs:
  org-repo-metrics-report:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Get organization repository metrics
        uses: nicklegan/github-org-repo-metrics-action@v2.0.1
        with:
          token: ${{ secrets.ORG_TOKEN }}
          fromdate: ${{ github.event.inputs.fromdate }} # Used for workflow dispatch input
          todate: ${{ github.event.inputs.todate }} # Used for workflow dispatch input
        # org: ''
        # days: '30'
        # stale: '14'
        # old: '120'
        # sort: 'openedPullRequests'
        # sort-order: 'desc'
        # json: 'false'
        # diff-report: 'false'
        # appid: ${{ secrets.APPID }}
        # privatekey: ${{ secrets.PRIVATEKEY }}
        # installationid: ${{ secrets.INSTALLATIONID }}

💡 Disable token expiration to avoid failed workflow runs when running on a schedule.

💡 JSON naming details used for sorting columns in the workflow file are specified below.

The additional option to retrieve organization metrics using a custom date interval. If the below fields are left empty during workflow_dispatch input, the default interval option of set days from the current date configured in action.yml will be used instead.

The results of all except the first column will be the sum or average of acquired metrics for the requested interval or all time per organization repository. The last row of the report will contain the totals per column for all repositories combined.

A CSV report file to be saved in the repository reports folder using the following naming format: organization-reportdate-interval.csv.

As an alternative you can use GitHub App authentication to generate the report. For larger organizations it is recommended to use this method as more API requests per hour are allowed which will avoid running into rate limit errors.

Register a new organization/personal owned GitHub App with the below permissions:

After registration install the GitHub App on your organization. Store the below App values as secrets.