Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gateixeira/manage-collaborators-action


https://github.com/gateixeira/manage-collaborators-action

Last synced: 25 days ago
JSON representation

Awesome Lists containing this project

README

        

# Manage Collaborators Action

![Check Dist/](https://github.com/gateixeira/manage-collaborators-action/workflows/Check%20Dist%2F/badge.svg)
![CodeQL](https://github.com/gateixeira/manage-collaborators-action/workflows/CodeQL/badge.svg)
![Publish](https://github.com/gateixeira/manage-collaborators-action/workflows/Publish/badge.svg)

---

This GitHub action adds and removes multiple users from multiple repositories.

If a user is already part of the repository, running it again with a different `permission` will change the permission of the user.

A user will be removed from the repository regardless whether the user accepted the invitation. A pending invitation will be cancelled.

---

## Inputs

| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
| -------------- | ---------------------------------------------------------------------------------------------- | -------- | -------- | ------- |
| `token` | A GitHub token with admin access to the target repositories | `string` | `true` | `N/A` |
| `users` | Comma-separated GitHub slug of users to provide access to. | `string` | `true` | `N/A` |
| `repositories` | Comma-separated GitHub slug of repositories to provide access to (format /). | `string` | `true` | `N/A` |
| `action` | The action to perform. Add or Remove. | `string` | `true` | `N/A` |
| `role` | Role of the user in the repository. Only required if action is add. | `string` | `false` | `N/A` |

---

## Usage example

Add the following snippet to an existing workflow file

```yml
- name: Run Manager Collaborators Action
id: manager-collaborators-action
uses: gateixeira/[email protected]
with:
token: ${{ secrets.REPO_ACCESS_TOKEN }}
repositories: owner/repo1,owner/repo2
users: user1,user2
role: push
action: add
```