Skip to content

Latest commit

 

History

History
57 lines (46 loc) · 2.11 KB

README.md

File metadata and controls

57 lines (46 loc) · 2.11 KB
Raw

auto-assign CircleCI

Assigns PRs automatically using round robin strategy. Auto assign supports multiple teams, and it works taking a PR owner's name and searching through teams member list, once the team is determined the reviewers list is used to assign a reviewer, team's names are used as key because of that each one must be different, each team has its own reviewers queue.

Installation

To install auto-assign you need to follow the next steps.

  1. Go to GitHub Settings/Developer settings and create a new GitHub App.
  2. Set a name,Webhook URL and Webhook secret it must match with the environment variable WEBHOOK_SECRET.
  3. The next permissions are required:
    1. Single file path: .github/auto_assign.yml access: Read-only
    2. Pull request: Read and write
    3. Issues: Read and write
  4. Subscribe to:
    1. Issues
    2. Pull request
  5. Add an auto_assign.yml file into your repo, in the .github folder using the next structure.
  6. Install your GitHub App to your repository.

Structure of auto_assign.yml

You can set a default list of assignees that will be applied when someone that is not a member of any team creates a PR/Issue, In order to do that, you just need to create a team called default. That team just need a list of assignees just as in the following example.

teams:
  - name: team_name_1
    members:
      - github_user_name_1
      - github_user_name_2
    assignees:
      - github_user_name_1
      - github_user_name_2

  - name: team_name_2
    members:
      - github_user_name_3
      - github_user_name_4
    assignees:
      - github_user_name_5

  - name: default
    assignees:
      - github_user_name_1
      - github_user_name_3

Testing

If you want to test something without affecting the queue order for your repo you can add a property scope: dev to your auto_assign.yml. This will force the app to use a memory queue instead of the database. WARNING: Keep in mind that every PR and Issue that you create using this property will be really assign.