Quick Start

The Vacation bot can reply to pull requests and issues with a special vacation message to let contributors know that not many people are around to respond.

Placing the following configuration in .devbots/vacation.yml in your repository will instruct the bot to post a comment to issues and pull requests for a specific time period.

enabled: true
pull-comment: >
    Thank you for submitting this pull request. Right now a lot of folks
    have taken time off until the end of the year, so it can take a
    little while before we can look at this PR. Please be patient and
    enjoy the holidays.
issue-comment: >
    Thank you for filing this issue. Most of us are on a break so it
    may take some time to respond or triage.
period: 2020-12-24 - 2021-01-04

Configuration

The Vacation bot automatically post a comment a new issue or pull-request is opened. You can use one comment for both or specify both a pull-comment and issue-comment if you want to have unique messages.

enabled boolean whether the bot is active or not
delay number the number of minutes to wait before a comment is posted. Defaults to immediately.
comment string the comment to add (not used if issue-comment or pull-comment is also given.
issue-comment string the comment to add to issues
pull-comment string the comment to pull requests
period YYYY-MM-DD - YYYY-MM-DD the date period in which to add the vacation message. A start and end date in YYYY-MM-DD format separated by a -, , or /.

The comment options may contain GitHub MarkDown and emojis.

Examples

Post a comment after a few minutes.

Placing the following configuration in .devbots/vacation.yml will make the bot post a vacation comment after 5 minutes.

enabled: true
delay: 5
pull-comment: >
  Thank you for submitting this pull request. Most of us are on a break
  until the new year, so it may take a little bit of time before we can
  look at, and review, this request.
issue-comment: >
  Thank you for filing this issue. Most of us are on a break until the
  new year, so it may take a little bit of time before we can respond
  to this issue.
period: 2020-12-24 - 2021-01-04

Posting just an issue comment

Placing the following configuration in .devbots/vacation.yml will make the bot post a comment immediately, just on issues:

enabled: true
period: 2020-12-24 - 2021-01-04
issue-comment: >
  > 🎄 Thank you for filing this issue. We will probably not look at
  until in the new year. 🎆