Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/actionsdesk/ghec-invitations-report-action
GitHub Action to create a report of GitHub Enterprise Cloud invitations
https://github.com/actionsdesk/ghec-invitations-report-action
github-enterprise-cloud reinvite-users reporting
Last synced: about 5 hours ago
JSON representation
GitHub Action to create a report of GitHub Enterprise Cloud invitations
- Host: GitHub
- URL: https://github.com/actionsdesk/ghec-invitations-report-action
- Owner: ActionsDesk
- License: mit
- Created: 2020-09-04T08:18:13.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T20:42:16.000Z (about 2 months ago)
- Last Synced: 2024-10-31T10:51:33.983Z (17 days ago)
- Topics: github-enterprise-cloud, reinvite-users, reporting
- Language: JavaScript
- Homepage:
- Size: 1.35 MB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Contributing: .github/contributing.md
- License: license
- Code of conduct: .github/code_of_conduct.md
- Codeowners: .github/codeowners
- Security: .github/security.md
Awesome Lists containing this project
README
# ghec-invitations-report-action
> GitHub Action to create a report of GitHub Enterprise Cloud invitations
[](https://github.com/ActionsDesk/ghec-invitations-report-action/actions/workflows/test.yml) [](https://github.com/ActionsDesk/ghec-invitations-report-action/actions/workflows/codeql.yml) [](https://github.com/prettier/prettier)
## Usage
**Scheduled report example**
```yml
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/[email protected]
with:
token: ${{ secrets.ADMIN_TOKEN }}
enterprise: 'my-enterprise'
report_path: 'reports/enterprise-invitations.csv'
```
On-demand report example
```yml
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/[email protected]
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
- [MIT License](./license)
[pat]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token 'Personal Access Token'