https://github.com/raulriera/probot-minimum-reviews

enforce a minimum number of reviews on Pull Requests
https://github.com/raulriera/probot-minimum-reviews

automation github-app probot probot-app probot-plugin

Last synced: 4 months ago
JSON representation

enforce a minimum number of reviews on Pull Requests

• Host: GitHub
• URL: https://github.com/raulriera/probot-minimum-reviews
• Owner: raulriera
• License: isc
• Created: 2018-04-09T02:43:27.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-07-06T02:19:39.000Z (over 6 years ago)
• Last Synced: 2024-04-29T23:00:40.038Z (9 months ago)
• Topics: automation, github-app, probot, probot-app, probot-plugin
• Language: JavaScript
• Homepage:
• Size: 22.5 KB
• Stars: 10
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Probot: Minimum Reviews [![Build Status](https://travis-ci.org/raulriera/probot-minimum-reviews.svg?branch=master)](https://travis-ci.org/raulriera/probot-minimum-reviews)

> a GitHub App built with [Probot](https://github.com/probot/probot) that enforces a minimum number of reviews in Pull Requests.

![Screenshot](https://user-images.githubusercontent.com/24159/38566574-0015d8b6-3cb2-11e8-872f-e9495192581e.png)

## Usage

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

2. Create `.github/minimum-reviews.yml` based on the following template.

3. It will wait for pull requests to be reviewed before marking them as ready to be merged.

A `.github/minimum-reviews.yml` file is required to enable the plugin.

```yml

# Number of reviews required to mark the pull request as valid

reviewsUntilReady: 2

# Number of changes in the pull request to start enforcing the reviewsUntilReady rule

changesThreshold: 100

# Message to display when the commit status passes

readyMessage: 'No pending reviews'

# Message to display when the commit status fails

notReadyMessage: 'Pending review approvals'

# Status to set the commit to when waiting for reviews

# 'failure, error, and pending' are the suggested options

notReadyState: 'pending'

```

## Deployment

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

[![Remix on Glitch](https://cdn.glitch.com/2703baf2-b643-4da7-ab91-7ee2a2d00b5b%2Fremix-button.svg)](https://glitch.com/edit/#!/remix/horn-produce)