PR Commands

Our GitHub bot along side automagically generating a CODEOWNERS file also allows you to customize your CODEOWNERS file to fit your needs. Below you will find a growing list of available commands that you can utilize on any PRs created by COBot.

Commands:

/co help

Usage:

Print usage details for all available COBot commands.

/co exclude

Usage:

Will exclude the provided users / teams from any recommendations that our bot makes (when used within a pull request the bot will make another commit with the new settings in mind).

Options:

--user, -u:  Refer to user(s), ex. -u @codeuser @devuser
--team, -t:  Refer to team(s), ex. -t @codeguys/devs

Examples:

/co exclude -u @codeuser || /co exclude --user @codeuser
/co exclude -t @codeguys/devs || /co exclude --team @codeguys/devs
/co exclude -t @codeguys/devs -u @codeuser || /co exclude --team @codeguys/devs --user @codeuser

/co include

Usage:

Will include the provided users / teams as a part of the recommendations our bot makes (by default all users/teams are included so this command is only really helpful if you have excluded this user or team before).

Options:

--user, -u:  Refer to user(s), ex. -u @codeuser @devuser
--team, -t:  Refer to team(s), ex. -t @codeguys/devs

Examples:

/co include -u @codeuser|| /co include --user @codeuser
/co include -t @codeguys/devs || /co include --team @codeguys/devs
/co include -t @codeguys/devs -u @codeuser || /co include --team @codeguys/devs --user @codeuser

/co suggest

Usage:

This command allows you to toggle whether the bot recommends teams or users

Options:

--user, -u:  Recommend users
--team, -t:  Recommend teams

Examples:

/co suggest -u || /co suggest --users
/co suggest -t || /co suggest --teams

DO NOT USE /co suggest -u -t, this will default to user suggestions

/co chown

Usage:

Add, remove or replace mentioned code owners to the lines selected for the comment.

(This command is only available on unified diff comments.)

Options:

add:           Append mentioned users/teams to the line
remove:     Remove mentioned users/teams from the line
replace:     Replace mentioned users/teams assignment on the line

Examples:

/co chown add @codeuser
/co chown remove @codeguys/devs
/co chown replace @codeguys/devs @codeuser