Skip to main content
Version: 3.16.0

Commands

Reviewpad commands introduce the ability to trigger reviewpad actions through a command-like instruction using pull request comments.

This is particularly useful when you want to trigger actions on a pull request that are not specified in the reviewpad configuration file.

A command is a comment that follows the following format:

/reviewpad [ACTION] [ACTION_ARGUMENTS]

Where ACTION is the action to be triggered and ACTION_ARGUMENTS are the arguments to be passed to the action.

Available commands

assign-reviewers


The assign-reviewers command triggers the $assignReviewer action.

This command assigns a defined amount of reviewers to the pull request from the provided list of reviewers.

Arguments:

ArgumentsDescription
comma_separated_list_of_reviewersList of GitHub logins to select from.

Flags:

FlagsDescription
-t, --total-reviewersThe total number of reviewers to assign to. By default, it assigns to all reviewers.
-p, --review-policyThe policy followed for reviewer assignment. By default, the policy is reviewpad.

Syntax:

/reviewpad assign-reviewers <comma_separated_list_of_reviewers> [--total-reviewers|-t] <total_required_reviewers> [--review-policy|-p] <review_policy>

Examples:

/reviewpad assign-reviewers john,jane
/reviewpad assign-reviewers john,jane --total-reviewers 1 --review-policy random
/reviewpad assign-reviewers jane,john -t 1 -p random