Skip to content

3. collaborators.md

Latest commit

 

History

History
53 lines (42 loc) · 2.11 KB

3. collaborators.md

File metadata and controls

53 lines (42 loc) · 2.11 KB

Configuring collaborator permissions

Your organization's default permissions will set the baseline, but in order to add users to CODEOWNERS they will still need to be added explicitly to a repository. For example, if your orgaization sets a baseline of push/write and a user is given read as a collabotor or team, they will be given CODEOWNERS access, but will inherit the write permission.

Note

This section can be applied to repos/<file>.yml or suborgs/<file>.yml. It will most commonly appear in the individual repos though.

Example collaborator definition

# These settings are synced to GitHub by https://github.com/github/safe-settings
collaborators:
  - username: Batman
    permission: maintain
  - username: Superman
    permission: admin

Collaborator API Spec

Tip

GitHub's API documentation defines these inputs and types:

  1. Add a repository collaborator
  2. Remove a repository collaborator

 username string ${\text{\color{orange}Required}}$

The handle for the GitHub user account.

 
collaborators:
  - username: AquaMan
    permission: maintain
...

 permission string 

The permission to grant the collaborator. Only valid on organization-owned repositories. We accept the following permissions to be set: pull, triage, push, maintain, admin and you can also specify a custom repository role name, if the owning organization has defined any.

Default: push

 
collaborators:
  - username: WonderWoman
    permission: maintain