/ghec-invitations-report-action

Primary LanguageJavaScriptMIT LicenseMIT

ghec-invitations-report-action

GitHub Action to create a report of GitHub Enterprise Cloud invitations

test codeql styled with prettier

Usage

Scheduled report example

on:
  schedule:
    # Runs at 00:00 UTC on the first of every month
    - cron: '0 0 1 * *'

name: Scheduled invitations report

jobs:
  report:
    runs-on: ubuntu-latest

    steps:
      - name: Create invitations report
        uses: ActionsDesk/ghec-invitations-report-action@v3.0.0
        with:
          token: ${{ secrets.ADMIN_TOKEN }}
          enterprise: 'my-enterprise'
          report_path: 'reports/enterprise-invitations.csv'
On-demand report example 
on:
  workflow_dispatch:
    inputs:
      enterprise:
        description: 'GitHub Enterprise Cloud account, if omitted the report will target the repository organization only'
        required: false
        default: 'my-enterprise'
      report_path:
        description: 'Path to the report file'
        default: 'reports/invitations.csv'
        required: false

name: Invitations

jobs:
  report:
    runs-on: ubuntu-latest

    steps:
      - name: Create invitations report
        uses: ActionsDesk/ghec-invitations-report-action@v3.0.0
        with:
          token: ${{ secrets.ADMIN_TOKEN }}
          enterprise: ${{ github.event.inputs.enterprise }}
          report_path: ${{ github.event.inputs.report_path }}

Action Inputs

Name Description Default Required
token A admin:org, read:user, repo, user:email scoped PAT true
report_path Path within the repository to create the report CSV file invitation-report.csv false
enterprise GitHub Enterprise Cloud account, will require admin:org, read:enterprise, read:user, repo, user:email scoped PAT for token. false

Note: If the enterprise input is omitted, the report will only be created for the organization the repository belongs to.

Action Outputs

Name Description
base_sha Report base SHA, needed for https://github.com/ActionsDesk/ghec-report-reinvite-action
head_sha Report head SHA, needed for https://github.com/ActionsDesk/ghec-report-reinvite-action

License