An open API service indexing awesome lists of open source software.

https://github.com/fastify/org-admin

Utilities to handle the organization's permissions
https://github.com/fastify/org-admin

cli hacktoberfest internal-tools

Last synced: 3 months ago
JSON representation

Utilities to handle the organization's permissions

Awesome Lists containing this project

README

          

# org-admin
Utilities to handle the organization's permissions

## Installation

```bash
npm install @fastify-org/org-admin
```

## Commands

### Onboard a user

This command adds a user to the specified teams in the GitHub organization.

```bash
node --env-file=.env index.js onboard --org --username --team --team [--dryRun]
```

For the fastify organization, the command would look like:

```bash
node --env-file=.env index.js onboard --username --team collaborators --team plugins --team website --team frontend
```

### Offboard a user

This command removes a user from the active teams in the GitHub organization and npm teams
and adds the user to the `emeritus` team if it exists.

```bash
node --env-file=.env index.js offboard --org --username [--dryRun]
```

### Check emeritus members

This command checks the last contribution date of org's members.
It creates an issue listing the users that have been inactive for more than a specified number of months.

```bash
node --env-file=.env index.js emeritus --org [--monthsInactiveThreshold] [--dryRun]
```

For the fastify organization, the command would look like:

```bash
node --env-file=.env index.js emeritus --monthsInactiveThreshold 24
```

## License

Licensed under [MIT](./LICENSE).