yproximite/pr-review-watcher

An open source tool to help code reviewer's to focus on what's important by reminding the developper to check for obvious things first.

Friday, November 18, 2016
by sf_tristanb
Repository
9 Watchers
6 Stars
2 Installations

JavaScript
0 Dependents
0 Suggesters
0 Forks
0 Open issues
17 Versions
0 % Grown

The README.md

PRReviewWatcher

, _(*1)

What the purpose of this project ?
Screenshots
How to install the project
Configuration
1. Security
2. Credential
3. Project
4. Vhost

Native Github Support

A few month ago, Github released a new feature that supports pull request templates. You should checkout the Documentation and see if it suits your need., _(*2)

What the purpose of this project ?

The PR Review Watcher will post a list of checks you've defined as a Pull Request comment when a new pull request is created, _(*3)

The project can save you time when it comes to pull request reviews:, _(*4)

avoid common pitfall/mistakes a developer can make
make sure the developper has reviewed his own code

The list of checks are fully customizable. No github credential's needed (just tokens, which are more secure)., _(*5)

Screenshots

Example webinterface , _(*6)

Example markdown editor , _(*7)

Example pull request comment , _(*8)

How to install the project

Simply install the project via composer: composer require yproximite/pr-review-watcher, _(*9)

Configuration

Security

Enter your desired login/sha1 password inside the file config/config.yml (cp config/config.yml.example to config/config.yml in order to access to the application., _(*10)

You can generate your sha1 password at sha1., _(*11)

Credential

First of all, you'll need a Github Token in order to post comments., _(*12)

Check out the GitHub documentation to see how to create one., _(*13)

Project

Then you add a project you want to hook into. Configure Github webhook by following this example :, _(*14)

Inside your GitHub project, go to settings then to webhooks & services.
Enter the url of the application + /api Example : https://[url_of_the_application]/api, select application/json and choose only the event Pull Request.

You can configure when to post comment on new pull request:, _(*15)

Post a checklist on a pull request only if it's opened against develop branch: enter "develop" in the field configured branches
Post a checklist on a pull request opened against all branches: enter "all"

Vhost

nginx example:, _(*16)

server {
    listen  80;
    server_name your.domain.name;

    access_log  /var/log/nginx/pr_watcher.access.log;
    error_log   /var/log/nginx/pr_watcher.error.log;

    root path/of/project/web;
    index index.php;

    location ~ /\.ht {
        deny all;
    }

    location ~ \.php$ {
        fastcgi_index index.php;
        fastcgi_split_path_info ^(.+\.php)(.*)$;
        include fastcgi_params;
        fastcgi_pass unix:/var/run/php5-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;   
    }

    location / { 
        try_files $uri $uri/ /index.php?$query_string;
    }
}

The Versions

18/11 2016

dev-master

9999999-dev https://github.com/Yproximite/PRReviewWatcher

An open source tool to help code reviewer's to focus on what's important by reminding the developper to check for obvious things first.

project pr-review-watcher

An open source tool to help code reviewer's to focus on what's important by reminding the developper to check for obvious things first.

yproximite/pr-review-watcher

The README.md

PRReviewWatcher

Native Github Support

What the purpose of this project ?

Screenshots

How to install the project

Configuration

Security

Credential

Project

Vhost

The Versions

dev-master

The Requires

by Corentin Dodon

v1.3.0

The Requires

by Corentin Dodon

v1.2.1

The Requires

by Corentin Dodon

dev-develop

The Requires

by Corentin Dodon

v1.2.0

The Requires

by Corentin Dodon

dev-feature/SameUser_DifferentBranch

The Requires

dev-feature/FA_icon

The Requires

v1.1.0

The Requires

dev-feature/fixTestOwnerToken

The Requires

v1.0.0

The Requires

dev-feature/configExample

The Requires

dev-feature/twig_error

The Requires

dev-feature/readme

The Requires

dev-feature/gitkeep

The Requires

dev-feature/reviewer

The Requires

dev-dev

The Requires

dev-test

The Requires