Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.47 KB

README.md

File metadata and controls

53 lines (37 loc) · 1.47 KB
Raw

Probot: Auto Assign Issues

A GitHub App built with Probot that auto-assigns any issues raised in a repository to specific users.

screenshot

How it works

  • When an issue is created on the repository, automatically assigns people to the pull request.
  • If a list of assignees is provided in configuration, adds them all to the issue.
  • If no assignees are provided, assigns the owner of the repository to the Issue.

Usage

  1. Install the app.
  2. Optionally create .github/auto-assign-issues.yml in your repository.
# If enabled, auto-assigns users when a new issue is created 
# Defaults to true, allows you to install the app globally, and disable on a per-repo basis
addAssignees: true

# The list of users to assign to new issues. 
# If empty or not provided, the repository owner is assigned
assignees:
  - reviewerA
  - reviewerB
  - reviewerC

When a new issue is created on the repository, one of the assignees or the repo owner will be assigned.

Development

# Install dependencies
npm install

# Run typescript
npm run build

# Run the bot
npm start

# Test before submitting a PR
npm test

If you have suggestions for how auto-assign-issues could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

ISC © 2019 Andrew Lock