Quick Start

Installing the bot on a repository

To install the bot, go to our page on GH Marketplace and click on Install.

wiki-images drawio (1)

Configuring the bot

To configure the bot, create a folder named Bot in the master branch of the repository you want to use the bot, and upload the [config.json]{https://github.com/biazottoj/issue-classification-bot/tree/main/Bot/config.json} file to this folder.

You can now edit the config.json to configure the bot. Below, you will find the main options for configuring the bot. To check all available options, please refer to the Documentation page.

Available commands

Interact with the Issue Classification Bot by using the following commands in the comments of a GitHub issues:

/tdbot label: Automatically labels an issue using the ML model. The bot can assign two labels
- "satd": indicates that the bot identified TD in the issue.
- "non-satd": indicates that the bot did not identify TD in the issue.
/tdbot label <label>: Manually labels an issue with the specified label.
/tdbot help: Displays this help message with command details.

Configuring (auto) labeling

payload-type: Choose between:
- "title": to set whether the bot's ML model should generate a label based on the title of the issue
- "description": to set whether the bot's ML model should generate a label based on the description of the issue
- "merged": to set whether the bot's ML model should generate a single label based on the title and the description of the issue
- "both": to set whether the bot's ML model should generate two separate labels based on the title and the description of the issue
auto-label: Boolean to set if the bot should automatically label new issues

Here is an example of a the command /tdbot label based on the issue description.

Configuring notifications

send-emails: Boolean to set if the bot should send email notifications
when-to-send: Choose between:
- "label": to set whether the bot should send email notifications when an issue is labeled
- "lingering": to set whether the bot should send email notifications when lingering issues have been identified in the repository
- "all": to set whether the bot should send email notifications for all the above scenarios
email-info: Configuration options for the email sender
- which-labels: if the bot should send email notifications when it adds a label to the issue (by setting when-to-send to "label" or "all"), choose between:
  - "all": if the bot should send email notifications for all kinds of labels
  - "except": if the bot should send email notifications for all kinds of labels except the ones specified in except-labels
  - "specific": if the bot should send email notifications only for the labels specified in specific-labels
- except-labels: the labels for which the bot does not send email notifications, specified as a list of strings: ["label1", "label2", ...]
- specific-labels: the labels for which the bot sends email notifications, specified as a list of strings: ["label1", "label2", ...]
recipients: the list of email addresses of contributors that should receive email notifications, specified as a list of strings: ["emailAddress1", "emailAddress2", ...]

Here is an example of an email sent by the bot based on a label.

Examples

Configuring the bot to automatically assign labels to issues.

To configure the bot automatically assign a label when a issue is created, you can alter the auto-label option on the configuration file:

"auto-label": true

With auto-label: true , issues such as the following would receive the label "SATD":

Summary: camel-http - does not remove httpClient.xxx URI options
Description: When using the options to configure httpClient using URI option, they should be removed from the uri that is left over to the HTTPProducer. should remove the httpClient.xxx so it's

While issues such as the following would receive the label "non-satd"

Summary: Opcodes.thrift missing from git repo
Description: It seems that Opcodes.thrift definition (required by Exprs.thrift in spec of TExprNode) is missing from git repository, causing project build failure.

Configuring notifications based on labels assigned to issues.

Configuring notifications for cerain labels might help to keep track of specific problems. For instance, to keep track and receive emails for issues with the label "SATD," the following options could be used:

"send-emails": true,
"when-to-send": "label",
"email-info": {
   "which-labels": "specific",
   "specific-labels": ["SATD"],
   "recipients" : [
      "contributor1@gmail.com",
      "contributor2@yahoo.com"
    ]
   "email-body-template": {
      "label": "Hi,\n\n/issue_label has been identified in issue #/issue_number",
   }
}

With the previous configuration, issues such as the following would trigger e-mails (i.e., the label SATD would be assigned to it):

Summary: Support using OperationAttributes through shell script
Description: Currently the ruby scripts for Put does not support setting of Operation Attributes through shell. It may be useful in some cases and also for testing. And that would give a full fledged support using shell.

While issues such as the following would not trigger e-mails (i.e., non-satd label):

Summary: FileNotFound on DFS block file
Description: While run the sort benchmark a reduce failed with: (No such file or directory) at Method).

Navigation Menu