Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 3.12 KB

README.md

File metadata and controls

63 lines (41 loc) · 3.12 KB
Raw

Remove Outside Collaborators Probot App

A GitHub Probot App that monitors and instantly removes any Outside Collaborators added to your Organization.

Features

  • Will automatically remove any outside collaborators from an organization.
  • Will create an issue in the repo explaining the action.
  • Monitor only mode will not remove any collaborators but will still create an issue.
  • Can set configuration parameters by using YAML file set in a specific repo for the entire org.
  • Can exclude certain members so that they can be added as outside collaborators.
  • Can set a list of users/groups to cc on every issue created

Get Started

  1. Configure the GitHub App
  2. [Recommended] Create repo named org-settings and in it a file .github/remove-outside-collaborators.yml as described in the How it Works section to configure settings (and override defaults)
  3. It will then prevent any outside collaborators (other than any whitelisted members) from being added to your organization.

How it Works

By default when an Outside Collaborator is added to a Repository, an Issue will be created in the Repository with a warning that a Collaborator was added. [Monitor-Only mode is enabled by default].

A .github/remove-outside-collaborators.yml file in the Repository org-settings is recommended to override the default settings. This Repository will contain global settings for the Organization. You can name the settings Repository anything you'd like, org-settings is just the default.

# Configuration for Remove-Outside-Collaborators

# Turn on Monitor Mode [SET ON BY DEFAULT]. In this mode Collaborators are not removed, only an Issue is created
monitorOnly: true

# Enables detection and removal of any Outside Collaborator being added to the assigned repositories
enableCollaboratorRemoval: true

# Issue Title when an Outside Collaborator is added
removedIssueTitle: '[CRITICAL] An Outside Collaborator has been added to this Repository!'

# Issue Body when an Outside Collaborator is added
removedIssueBody: 'NOTE: Outside Collaborators are disabled for this organization! <br/> This member has been removed. Please contact an admin to override.'

# Issue Title when monitor mode is enabled
monitorIssueTitle: '[CRITICAL] Outside Collaborator Added'

# Issue Body when monitor mode is enable
monitorIssueBody: 'Please note that the adding of Outside Collaborators is prohibited!'

# Users/Groups that should be cc'ed on the issue. Should be users/groups separated by a space.
# ccList: '@user123 @user456'

# Collaborators to exclude in detection. Should be a List of Strings.
# excludeCollaborators: ['user1', 'user2']

When setting up this Probot App you can also set a number of Environment Variables

Deployment

See docs/deploy.md if you would like to run your own instance of this app.

Possible Environment Variables:

  • FILE_NAME [default: '.github/remove-outside-collaborators.yml'] - Sets the location/file name of the config yml file
  • ORG_WIDE_REPO_NAME [default: 'org-settings'] - Set the repo where to find the config yml file