https://github.com/z0al/probot-review-me

Decide when a pull request is ready for review based on its statuses
https://github.com/z0al/probot-review-me

github github-app nodejs probot probot-app pull-requests review-app

Last synced: 4 months ago
JSON representation

Decide when a pull request is ready for review based on its statuses

• Host: GitHub
• URL: https://github.com/z0al/probot-review-me
• Owner: z0al
• License: mit
• Created: 2018-02-22T15:34:44.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-08-31T13:57:11.000Z (over 6 years ago)
• Last Synced: 2024-09-27T08:02:26.429Z (4 months ago)
• Topics: github, github-app, nodejs, probot, probot-app, pull-requests, review-app
• Language: JavaScript
• Homepage:
• Size: 179 KB
• Stars: 16
• Watchers: 4
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Review Me

[![Travis](https://img.shields.io/travis/ahmed-taj/probot-review-me.svg)](https://travis-ci.org/ahmed-taj/probot-review-me)

A GitHub App built with [probot](https://github.com/probot/probot) that helps you to decide when a pull request is ready for review based on its statuses.

## Why?

It's not always necessary for all status checks to pass, sometimes we need more than ✕ or ✓ to determine if a pull request is ready for review or not.

## How it works

The app listens to pull request statuses and adds a review label (`[Review me]` by default) if all statuses matched. Otherwise, it removes the label.

![screenshot](./docs/screenshot.png)

That way, maintainers/reviewers can filter pull requests to look only into ready ones.

## Usage

1. **[Configure the GitHub App](https://github.com/apps/review-me)**

2. Create `.github/review-me.yml` based on the following template

3. It will start to listen to pull request statuses and update them accordingly.

A `.github/review-me.yml` file is required to enable the app:

```yaml

# List of contexts (i.e. apps) and their corresponding statuses

when:

  # Allowed statuses are:

  #

  #   - success

  #   - failure

  #   - pending

  #   - error

  continuous-integration/travis-ci/pr: success

  wip: success

# Override default label (optional)

label: Review Me

```

## Development

```

# Install dependencies

npm install

# Run the bot

npm start

```

## Deployment

See [docs/deploy.md](docs/deploy.md) if you would like to run your own instance of this app.

## You might also like

* **[commitlint-bot](https://github.com/ahmed-taj/commitlint-bot):** A GitHub App that runs commitlint for you!

* **[DEP](https://github.com/ahmed-taj/dep):** A Github App that helps managing PR dependencies

## License

MIT © [Ahmed T. Ali](https://github.com/ahmed-taj)