Commands

This is a list of the commands that zulipbot currently supports.

• Commands edited to be included in a comment/description will not work.
  • The lack of support for edited comments/descriptions is a result of an inconsistency in the GitHub API.
• Commands within code blocks will be ignored.
• zulipbot supports customizable command aliases, which can be created by modifying the configuration file (src/config.js).

Format

@username command "multiple" "arguments"

• username — The username object configured in src/secrets.js; the username that zulipbot is authenticated as.
• command — The specified command that will trigger a response or action from zulipbot.
• "multiple" "arguments" — The arguments for commands are surrounded with double quotes ("); only certain commands require arguments.

Commands

@username claim

Assigns the commenter to an issue (or issue creator if included in an issue description). Works in issue comments and issue descriptions.

• Gives new contributors repository permissions based on the addCollabPermission object configured in src/config.js; either pull, push, or admin; if undefined, contributors will not be given any permissions.
• If inProgressLabel is defined in src/config.js, a label with the value of inProgressLabel will be added to the claimed issue.
• Can be enabled/disabled by configuring the claimEnabled object configured in src/config.js.

@username abandon

Unassigns the commenter from an issue. Works in issue/pull request comments.

• If inProgressLabel is defined in src/config.js and is labeled on the abandoned issue/pull request, a label with the value of inProgressLabel will be removed from the issue/pull request.
• Can be enabled/disabled by configuring the abandonEnabled object configured in src/config.js.

@zulipbot label "label name"

Adds existing repository labels to issues and pull requests. Works in issue descriptions and issue/pull request comments.

• Attempts to add nonexistent repository labels to an issue/pull request will result in an error message.
• Travis build notifications can be added to pull requests using @username label "travisUpdatesLabel" where travisUpdatesLabel is the travisUpdatesLabel configured in src/config.js.
• Configure the selfLabelingOnly object in src/config.js to only allow issue/pull request creators to label their own issues/pull requests.
• Can be enabled/disabled by configuring the labelEnabled object configured in src/config.js.

@zulipbot remove "label name"

Removes labels from issues and pull requests. Works in issue descriptions and issue/pull request comments.

• Attempts to remove invalid labels from an issue/pull request will result in an error message.
• Configure the selfLabelingOnly object in src/config.js to only allow issue/pull request creators to remove labels from their own issues/pull requests.
• Can be enabled/disabled by configuring the removeEnabled object configured in src/config.js.

@zulipbot join "area label name"

Adds the commenter to specified area label teams (or issue/pull request creator if included in an issue/pull request description). Works in issue/pull request descriptions and issue/pull request comments.

• This command should be enabled only if:
  • The monitored repository is owned by an organization.
  • The repository's organization has already had area label teams created prior to usage.
• If the user is not part of the GitHub organization, the user will be prompted to accept an invitation link. If the user is already a part of the GitHub organization, the user will be automatically added.
• Can be enabled/disabled by configuring the joinEnabled object configured in src/config.js.