action.yml

name: 'Copilot Report'
description: 'GitHub Copilot Enterprise licence and AI credit usage report, optionally enriched with Entra ID or JumpCloud department data'
inputs:
  github-token:
    description: 'PAT with read:enterprise and manage_billing:enterprise scopes. Cannot be the built-in GITHUB_TOKEN.'
    required: true
  enterprise:
    description: 'GitHub Enterprise slug'
    required: true
  upn-domain:
    description: 'Email domain for directory lookup when GitHub carries no email address (e.g. example.com)'
    required: false
    default: ''
  entra-tenant:
    description: 'Override the Azure AD tenant ID for the Graph API lookup. Auto-resolved from upn-domain via OIDC discovery; only needed when that result is incorrect.'
    required: false
    default: ''
  jumpcloud-api-key:
    description: 'JumpCloud admin API key. Enables JumpCloud department enrichment instead of Entra ID.'
    required: false
    default: ''
  credits:
    description: 'Override credits-per-seat value if your portal shows a different pool size'
    required: false
    default: ''
  output:
    description: 'Output CSV file path (default: $REPORT_DIR/copilot-report-YYYYMMDD.csv)'
    required: false
    default: ''
  report-dir:
    description: 'Output directory for the CSV report when output is not given'
    required: false
    default: './reports'
  no-entra:
    description: 'Skip Entra ID department lookup'
    required: false
    default: 'false'
  no-jumpcloud:
    description: 'Skip JumpCloud department lookup'
    required: false
    default: 'false'
  no-budgets:
    description: 'Skip per-user AI credit budget lookup (Universal/Individual)'
    required: false
    default: 'false'
runs:
  using: composite
  steps:
    - name: Generate Copilot report
      shell: bash
      env:
        GITHUB_TOKEN: ${{ inputs.github-token }}
        GITHUB_ENTERPRISE: ${{ inputs.enterprise }}
        UPN_DOMAIN: ${{ inputs.upn-domain }}
        ENTRA_TENANT: ${{ inputs.entra-tenant }}
        JUMPCLOUD_API_KEY: ${{ inputs.jumpcloud-api-key }}
        CREDITS_PER_SEAT_OVERRIDE: ${{ inputs.credits }}
        REPORT_DIR: ${{ inputs.report-dir }}
      run: |
        ARGS=()
        [[ -n "${{ inputs.output }}" ]]   && ARGS+=(--output "${{ inputs.output }}")
        [[ "${{ inputs.no-entra }}" == "true" ]] && ARGS+=(--no-entra)
        [[ "${{ inputs.no-jumpcloud }}" == "true" ]] && ARGS+=(--no-jumpcloud)
        [[ "${{ inputs.no-budgets }}" == "true" ]] && ARGS+=(--no-budgets)
        "${{ github.action_path }}/github-copilot-report.sh" "${ARGS[@]}"