Annoy-o-Bot

This is a simple GitHub app which can create issues on pre-defined schedules for you. Use this app to check-in and manage reminders and other tasks in source-control.

Create a reminder

Each reminder is represented by a unique JSON or YAML document inside the .reminders folder. Reminders need a .json or .yaml file ending. The app only takes reminders commited to the default branch (typically master) into account.

The file supports the following properties:

Property	Type	Required	Description
Title	string	mandatory	The title of the issue being created.
Message	string	mandatory	The issue description for the issue being created. See https://yaml-multiline.info/ on how to create multi-line reminder messages using YAML.
Labels	string array	optional	An array of labels to add
Assignee	string	optional	A ; deliminited list of users/teams being assigned to the issue.
Date	string	mandatory	A ISO 8601 standard date string indicating when the issue should be created the first time.
Interval	string	mandatory	Defines the interval granularity in which a new issue should be created after the first date. See interval description for more detail.
IntervalStep	digit	optional	Defines how many intervals should be used before raising the next issue. This allows to customize intervals to something like "every 3 months", "every second week" and so on.

Intervals

The following intervals are supported: Daily, Weekly, Monthly, Yearly, Once.

Example

As YAML: .reminders/demo-reminder.yaml

Title: My first reminder
Message: hello world!
Assignee: johndoe
Labels:
- Label1
- Label2
Date: 2020-01-01
Interval: Monthly

Important

The YAML parser is case-sensitive. Make sure to use the documented property names.

As JSON: .reminders/demo-reminder.json

{
  "title": "My first reminder",
  "message": "hello world!",
  "assignee": "johndoe",
  "labels": ["Label1", "Label2"],
  "date": "2020-01-01",
  "interval": "Monthly"
}

This sample will immediately create a new issue (because the specified start date already passed) with the title My first reminder and assign it to the github user johndoe. It will then re-create this issue every month on the first of the month.

Update a reminder

Update an existing reminder document to change the scheduled interval or issue details to be created.

Delete a reminder

Delete the reminder document you want to remove.

Icon

Alarm by Adrien Coquet from the Noun Project