PReviewer

PReviewer is a Github app build with Probot to automate the PR review.

Features

• Auto request PR review to contributors
• Review PR title formatting
• Review and comments if PR checklist are not completed
• Blocks merging if PR checklist are not completed

Installation

Clone the repo

# Clone the repo
git clone [email protected]:akasrai/previewer.git

Install the app

# Install dependencies
npm install

# Build the project
npm run build

# Run the bot
npm start

Setup GitHub app Navigate to local server (ie. http//locahost:3000) in the browser and follow the steps to setup the github app

Install bot in the GitHub repo

• Bot can be installed in the desired GitHub repo from the app settings
• Add configuration file (previewer.yml) in .github folder in the root of target GitHub repo

License

ISC © 2021 akash [email protected]