highsolutions/github-hook

A Laravel package for simple Continuous Integration based on GitHub push.

Laravel GitHub Hook

Easy continuous integration based on GitHub., _(*1)

, _(*2)

Installation

Add the following line to the require section of your Laravel webapp's composer.json file:, _(*3)

    "require": {
        "HighSolutions/github-hook": "*"
    }

Run composer update to install the package., _(*4)

This package uses Laravel 5.5 Package Auto-Discovery. For previous versions of Laravel, you need to update config/app.php by adding an entry for the service provider:, _(*5)

'providers' => [
    // ...
    HighSolutions\GitHubHook\GitHubHookServiceProvider::class,
];

Configuration

Finally, from the command line again, publish the default configuration file:, _(*6)

php artisan vendor:publish --provider="HighSolutions\GitHubHook\GitHubHookServiceProvider"

and you can specify some essentials settings (in ENV and in config file called github-hook.php):, _(*7)

You can specify whole configuration in .env file:, _(*8)

GITHUB_HOOK_URL=/github/hook/
GITHUB_HOOK_BRANCH=master
GITHUB_HOOK_SECRET=
GIHUB_HOOK_BEFORE="php artisan help###php artisan help"
GITHUB_HOOK_HOOK_MIGRATION="php artisan migrate --force"
GITHUB_HOOK_HOOK_SEED="php artisan db:seed --force"
GITHUB_HOOK_HOOK_REFRESH="php artisan migrate:refresh --seed --force"
GITHUB_HOOK_HOOK_COMPOSER="php composer.phar install --no-dev"
GITHUB_HOOK_HOOK_CACHE="php artisan cache:clear"
GITHUB_HOOK_HOOK_VIEW="php artisan view:clear"
GIHUB_HOOK_AFTER="php artisan help###php artisan optimize"
GITHUB_HOOK_HOOK_SENDER=GitHub
GITHUB_HOOK_SLACK_CHANNEL=
GITHUB_HOOK_SLACK_URL=

Remember surround values containg spaces with "., _(*9)

No Laravel version

This package is also configured to work not within Laravel. We recommend: - Create hook folder - Copy whole package to this folder - Create another file (e.g. awesome_hook.php) and paste in it:, _(*10)

<?php

require_once 'github-hook/src/Services/GitHubHookService.php';

HighSolutions\GitHubHook\Services\GitHubHookService::simpleInit([
    'secret' => null, // secret of webhook
    'branch' => 'master', // branch name
    'path' => '/home/www/', // absolute path to the repo
], $_POST['payload'], $_SERVER['x-hub-signature'], [
    'composer' => 'composer install --no-dev',
]);

Configure GitHub webhook to access this second file and voila!, _(*11)

You can also upload only service file github-hook/src/Services/GitHubHookService.php and then you need to change path to:, _(*12)

<?php

require_once 'GitHubHookService.php';

...

Changelog

0.11.0 - Support Laravel 9.0, 10, and 11.x, _(*13)

0.9.0 - Support Laravel 8.0, _(*14)

0.8.1 - Add slack-notification-channel dependency, _(*15)

0.8.0 - Support Laravel 7.0, _(*16)

0.7.0 - Support Laravel 6.0, _(*17)

0.6.0 - Support Laravel 5.8, _(*18)

0.5.0 - Add before and after hooks, _(*19)

0.4.1 - Wrong package in Auto-Discovery definition., _(*20)

0.4.0 - Support Package Auto-Discovery - composer install --no-dev instead of composer update --no-scripts as default command for composer hook, _(*21)

0.3.0 - cache and view clear commands, _(*22)

0.2.3 - ping request fixes, _(*23)

0.2.0, _(*24)

• no Laravel example
• no edit flag in git push
• support for ping request
• composer's hook
• hooks declarations
• conditional hooks based on committed files

0.1.0, _(*25)

• created package
• events
• slack notification
• hash verification

Roadmap

• Asynchronous option
• Comments
• Unit tests!

Credits

This package is developed by HighSolutions, software house from Poland in love in Laravel., _(*26)