A GitHub Action to generate a report which contains repository collaborator details for a GitHub organization.

The example workflow below runs on a weekly schedule and can also be executed manually using a workflow_dispatch event.

name: Repo Collaborator Action

on:
  workflow_dispatch:
  schedule:
    # Runs on every Sunday at 00:00 UTC
    #
    #        ┌────────────── minute
    #        │ ┌──────────── hour
    #        │ │ ┌────────── day (month)
    #        │ │ │ ┌──────── month
    #        │ │ │ │ ┌────── day (week)
    - cron: '0 0 * * 0'

jobs:
  github-collaborator-report:
    runs-on: ubuntu-latest

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

      - name: Get repo collaborator report
        uses: nicklegan/[email protected]
        with:
          token: ${{ secrets.ORG_TOKEN }}
        # org: ''
        # affil: 'ALL'
        # permission: 'ADMIN'
        # days: '90'
        # json: 'FALSE'
        # appid: ${{ secrets.APPID }}
        # privatekey: ${{ secrets.PRIVATEKEY }}
        # installationid: ${{ secrets.INSTALLATIONID }}

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

💡 If the organization has SAML SSO enabled, make sure the personal access token is authorized to access the organization.

If the organization name in the workflow is left blank, the Action will generate a report for the organization the workflow is located in.

💡 A CSV report file will be saved in the repository reports folder using the following naming format: organization-affil-permission-report.csv.

As an option you can use GitHub App authentication to generate the report.

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

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