A GitHub Action to generate a report that contains code frequency metrics and programming languages used per repository belonging to a GitHub organization.

The example workflow below runs on a monthly schedule using the amount of weeks as an interval set in action.yml (default 4 weeks) and can also be triggered manually using a workflow_dispatch event.

name: Code Frequency Action

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:
  code-frequency-report:
    runs-on: ubuntu-latest

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

      - name: Get Git audit-log
        uses: nicklegan/github-org-code-frequency-action@v1.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

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

The additional option to retrieve code frequency data using a custom date interval. If the below fields are left empty during workflow dispatch input, the default interval option of set weeks from the current date configured in main.yml will be used instead.

💡 The result data includes the weeks which have their start date (Sunday 00:00:00 GMT) within the set interval.

The results of the 2nd and 3rd report column will be the sum of code frequency date for the selected interval per organization repository.

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

In some scenarios it might be preferred to authenthicate as a GitHub App rather than using a personal access token.

The following features could be a benefit authenticating as a GitHub App installation:

• The GitHub App is directly installed on the organization, no separate user account is required.
• A GitHub App has more granular permissions than a personal access token.
• To avoid hitting the 5000 requests per hour GitHub API rate limit, authenticating as a GitHub App installation would increase the API request limit.

The GitHub App authentication strategy can be integrated with the Octokit library by installing and configuring the @octokit/auth-app npm module before rebuilding the Action in a separate repository.