A GitHub Action to generate a report to retrieve pending and failed invitations for a GitHub cloud enterprise or organization.

name: Invitation Report

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

jobs:
  invitation-report:
    runs-on: ubuntu-latest

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

      - name: Get invitation report
        uses: nicklegan/github-enterprise-invitation-action@v2.0.0
        with:
          token: ${{ secrets.ORG_TOKEN }}
        # org: ''
        # enterprise: ''
        # sort: 'created_at'
        # sort-order: 'desc'
        # json: 'false'

💡 The read:enterprise scope is only needed when running the Action on the enterprise level.

💡 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. If an enterprise slug is used in the workflow, this will supersede the organization parameter and the Action will run on the enterprise level instead.

💡 JSON column name details used for sorting CSV columns by key used in the workflow file are specified below.

A CSV report file will be saved in the repository reports folder using the following naming format: organization/enterprise-invitations.csv.