Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.56 KB

README.md

File metadata and controls

60 lines (41 loc) · 2.56 KB
Raw

Probot: No Response

a GitHub App built with Probot that closes Issues where the author hasn't responded to a request for more information.

Bot Workflow

The intent of this bot is to close issues that have not received a response to a maintainer's request for more information. Many times issues will be filed without enough information to be properly investigated. This allows maintainers to label an issue as requiring more information from the original author. If the information is not received in a timely manner, the issue will be closed. If the original author comes back and gives more information, the label is removed and the issue is reopened if necessary.

Scheduled

Once per hour, it searches for issues that are:

  • Open
  • Have a label named the same as the responseRequiredLabel value in the configuration
  • The responseRequiredLabel was applied more than daysUntilClose ago

For each issue found, it:

  1. If closeComment is not false, posts the contents of closeComment
  2. Closes the issue

issue_comment Event

When an issue_comment event is received, if all of the following are true:

  • The author of the comment is the original author of the issue
  • The issue has a label named the same as the responseRequiredLabel value in the configuration

It will:

  1. Remove the responseRequiredLabel
  2. Reopen the issue if it was closed by someone other than the original author of the issue

Usage

  1. Configure the GitHub App
  2. Create .github/no-response-milestones.yml

A .github/no-response.yml file is required to enable the app. The file can be empty, or it can override any of these default settings:

# Configuration for probot-no-response - https://github.com/probot/no-response

# Number of days of inactivity before an Issue is closed for lack of response
daysUntilClose: 14
# Label requiring a response
responseRequiredLabel: status-needsinfo
# Milestone to move stale issues
staleMilestone: 7
reopenedMilestone: 1
# Comment to post when closing an Issue for lack of response. Set to `false` to disable
closeComment: >
  This issue has been automatically closed because there has been no response
  to our request for more information from the original author. With only the
  information that is currently in the issue, we don't have enough information
  to take action. Please reach out if you have or find the answers we need so
  that we can investigate further.

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