Tool to auto-close old GitHub issues that were abandoned by their reporter
Scala Shell
Latest commit 1378c7b Jun 28, 2016 @cvrebert cvrebert committed on GitHub Merge pull request #19 from twbs/lic
Update copyright notice

README.md

NO CARRIER

Build Status Development Status :: 4 - Beta MIT License

NO CARRIER is a tool to auto-close old GitHub issues that were abandoned by their reporter, which is to say that we were waiting for a response from the reporter but never got a response in a reasonable amount of time.

Named after the message indicating that your dial-up modem has lost its connection.

Motivation

You're a member of a popular open source project. Cool.

But due to the project's popularity, you get lots of bug reports on the issue tracker, and often these reports are lacking key information that's explicitly mentioned in your bug reporting docs as being required. Or maybe you just need extra information or test results from the bug reporter. So, okay, you post nice reply comments on the issues, asking the reporters for the information or requesting that they do some investigation/tests.

And then you wait for a reply. Unfortunately, for whatever reason, a surprisingly large fraction of folks never end up replying to your questions/requests. So unactionable issues start to pile up. You occasionally review the oldest batch of such issues and close them manually.

By automating the process of closing abandoned issues, the issue tracker is kept clean with less tedium on the part of issue triagers. The abandoned issue expiration policy is also applied more uniformly/fairly, and it's easier to use a canonical template for the closing issue comment that clearly and politely explains the reason for the closure.

Example of the bot in action: Screenshot of the bot closing an issue

Used by

Usage

NO CARRIER is designed to be run as a cron job.

Java 8+ is required to run NO CARRIER. You can download NO CARRIER's prebuilt assembly JAR from our GitHub Releases page. For instructions on building NO CARRIER yourself from source, see the Contributing docs.

NO CARRIER requires 2 environment variables to be set:

  • $GITHUB_USERNAME - Username of GitHub user for NO CARRIER to login as
  • $GITHUB_PASSWORD - Password of GitHub user for NO CARRIER to login as

NO CARRIER accepts exactly 3 command line arguments. Once you have the JAR, run e.g. java -jar no-carrier.jar <owner/repo> <label> <days>. Here's what each of the arguments is:

  • owner/repo: GitHub repo whose issues will be operated upon (example: twbs/bootstrap for Bootstrap)
  • label: Name of label used on the repo's GitHub issue tracker to indicate that the issue is blocked waiting for a reply from a user (typically the issue's original poster).
  • days: Integer number of days. If at least this number of days elapses after an issue has been labeled without any new comment being posted, NO CARRIER will close the issue and post an explanatory comment.

Heroku

We also have specific instructions for setting up NO CARRIER on Heroku, courtesy of @zxqfox.

License

NO CARRIER is released under the MIT License.

Acknowledgments

We all stand on the shoulders of giants and get by with a little help from our friends. NO CARRIER is written in Scala and built on top of:

See also