The PRBot was created to automatically create a new pull request, when a merge-back was forgotten. For example; if a hotfix was made for version 1.1, it should also be merged back to your development branch. The PRBot should run every morning, to remind you what's still in need of a merge-back.
In order to run the PRBot, you need to have the following available:
- A server with a CRON-job
- PHP 5.4 or higher
- Have the PHP CURL module enabled
- A Github account with READ access to the repositories you want to monitor
Once you downloaded all the files, make sure you run composer install
with composer.
Copy the dev/config.dist.php
to dev/config.php
, and edit the file to configure your setup.
<?php
return [
'username' => 'myMergeBot', // Your github username
'password' => 'somepass123', // Your github password
// The title that will be used for your PRs, the first %s being the
// branch to merge from, the second %s being the to branch to merge to.
'prTitle' => 'Make sure that %s is in %s!',
// Message the PRBot uses for the pull request:
'prBody' => '![](https://heavyeditorial.files.wordpress.com/2012/08/thumbsup.gif)',
'github' => [
// http://github.com/SomeUserOrOrganisation/ProjectA
'SomeUserOrOrganisation' => [
'ProjectA' => [
// Merges back release/1.1 into release/1.2
'release/1.1' => 'release/1.2',
// Merges back release/1.2 into develop
'release/1.2' => 'develop',
],
],
// http://github.com/AnotherUserOrOrganisation/ProjectB
'AnotherUserOrOrganisation' => [
'ProjectB' => [
// Merges back release/2.0 into develop
'release/2.0' => 'develop',
// Merges back master into develop
'master' => 'develop',
],
],
],
];
We recommend that you configure your cronjob to run every morning before you get to work. For example at 5am from monday to friday: