Skip to content

Latest commit

 

History

History
104 lines (75 loc) · 3.64 KB

repokitteh.md

File metadata and controls

104 lines (75 loc) · 3.64 KB

RepoKitteh

What is RepoKitteh?

RepoKitteh is a GitHub application that provides an easy way to create, integrate and maintain GitHub bots. It is deployed in GCP and supplied to Envoy under a contract with the CNCF. The application is installed on specific GitHub repositories and interacts with these by receiving webhooks and making GitHub API calls. A root repokitteh.star script tells the application what to do based on the webhook received.

Integration with Envoy

The file repokitteh.star, which resides in the root of the Envoy repository tells RepoKitteh what functionality to use. The file is written in the Starlark language, which is a Python dialect with well defined threading and hermeticity guarantees.

For example, the statement

use("github.com/repokitteh/modules/assign.star")

tells RepoKitteh to use the assign.star module. Similar modules can be integrated in the future into Envoy in the same way.

Current Functionality

Set assignees to issues or pull requests.

Examples:

/assign @someone

Adds @someone as an assignee to the issue or pull request that this comment is made on.

/unassign @someone

Removes @someone as an assignee.

Only organization members can assign or unassign other users, who must be organization members as well.

Demo PR

Requests a user to review a pull request.

Examples:

/review @someone

Asks @someone to review the pull requests that this comment is made on.

/unreview @someone

Removes @someone from the reviewers list.

Only organization members can request a review from other users or cancel it, who must be organization members as well.

Demo PR

Wait for activity on an issue or a PR.

Example:

/wait

Sets the label waiting on a PR. When a new commit is pushed the label will be removed.

Demo PR

It is also possible to wait until any comment is submitted and/or a new commit is pushed.

Example:

/wait-any

Sets the label waiting:any on a PR. When a new commit is pushed or any comment is submitted the label will be removed.

Demo PR

Restart failed CircleCI tests.

Example:

/retest

Restarts all failed CircleCI tests, as reported in the commit statuses.

Demo PR

Two types of approvals:

  1. Global approvals, done by approving the PR using Github's review approval feature.
  2. Partial approval, done by commenting "/lgtm [label]" where label is the label associated with the path. This does not affect GitHub's PR approve status, only this module's maintained commit status. This approval is automatically revoked if any further changes are done to the relevant files in this spec.

Backport labeling

/backport

will labels the PR commented on with backport/review.