Skip to content

πŸ“Š πŸ“‘ Action to generate a report as markdown, html or json with the members, outside collaborators and pending invites.

License

Notifications You must be signed in to change notification settings

orquestradigital-actions/enterprise-members-report-action

Β 
Β 

Repository files navigation

Enterprise members report action

Action to generate a report as markdown, html, csv or json with the members, outside collaborators and pending invites.

Description

This action generates a report for an enterprise with the following elements:

  • Members: a report of all users that are members of at least one org in the enterprise
  • Outside collaborators: a compilation of all outside collaborators in all the orgs
  • Pending invites: the list of all pending invites in all the orgs

How to

This actions has the following inputs:

Parameter Description Default Is Required
token A personal access token with permissions on all the orgs of the enterprise None βœ…
enterprise The enterprise where we want to generate the report None βœ…
format Determines how the output parameter will be formatted. Supports: json, markdown, csv and html None βœ…

This action has the following outputs:

Parameter Description
data he data extracted from the license API calls in the format specified. The type of the output is always string

Here you can see a workflow example using this action:

name: Report workflow
on: 
  schedule:
    # every Tuesday at 07:00 UTC
    - cron: '0 7 * * 3'

jobs:
  sendReport:
    runs-on: 'ubuntu-latest'
    steps:
    - name: Generate report
      id: report
      uses: ActionsDesk/enterprise-members-report-action@latest
      with:
        # Remember GITHUB_TOKEN doesn't work here as we require to have access to the enterprise
        token: ${{ secrets.TOKEN }} 
        enterprise: avocado-corp
        format: 'html'
    # Then use ${{ steps.report.outputs.data }} to store/send the report somewhere
    - run: echo '${{ steps.report.outputs.data }}'

About

πŸ“Š πŸ“‘ Action to generate a report as markdown, html or json with the members, outside collaborators and pending invites.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.7%
  • JavaScript 1.3%