regis

Regis

Let Regis inspect your pull requests for style violations and other boring details… you should be the one to do the real code review!

Regis is like your personal (and self-hosted) assistant, let him to the tedious work and focus on what's important. He will monitor a configured set of repositories, analyse their pull requests and directly comment in the code when style violations or errors are found.

Installation

Regis needs PHP >= 7.0.

Once the project is cloned, its dependencies can be installed using Composer:

php composer.phar install

You will be asked to configure a few parameters like the configuration options to use to connect to Redis, RabbitMQ, etc.

If you use Docker, setting up these services will be easier. A docker-compose.yml file is provided and can be launched using:

docker-compose -f docker/docker-compose.yml up

Then, configure RabbitMQ using the following command:

docker-compose -f docker/docker-compose.yml run web ./vendor/bin/rabbit vhost:mapping:create --host rabbit --user admin app/config/rabbitmq_vhost.yml

Regis is now accessible at http://localhost:8080/app_dev.php

Tests

Run make tests

Private repositories

In order to be able to inspect private repositories, Regis needs its own SSH keys. They are usually stored in ./var/ssh. You can then declare a key to GitHub using the following command:

./bin/console regis:github:add-deploy-key --owner=K-Phoen --repository=regis-test --public-key=./var/ssh/id_rsa_test_regis.pub

License

This project is under the GNU AGPLv3 license.