KO
|
EN
gitlite — search
Search
#javascript
#python
#hacktoberfest
#react
#ai
#typescript
#llm
#go
#golang
#android
#machine-learning
#rust
#deep-learning
#linux
laravel-github-hook
★ 8
Open GitHub ↗
No description available.
Download README (.md)
Explore Similar Repositories
tracking
:
Compare Compressive Tracker and KCF Tracker
okhttp-android-tests
:
Set of Android instrumentation tests for OkHttp.
stalker_pyramid2
:
A Pyramid Web Application Build On Top of Stalker
rails-api-template
:
Rails API Only Template
slide_thesis_ioslides
:
The slide for my thesis defence using ioslides in Rstudio.
// repository documentation
Was this content helpful?
★ 0
(0 ratings)
Select Rating:
★
★
★
★
★
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
laravel-github-hook
?
Download (.md)
Laravel GitHub Hook =================== Easy continuous integration based on GitHub.  Installation ------------ Add the following line to the `require` section of your Laravel webapp's `composer.json` file: ```javascript "require": { "HighSolutions/github-hook": "*" } ``` Run `composer update` to install the package. 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: ```php 'providers' => [ // ... HighSolutions\GitHubHook\GitHubHookServiceProvider::class, ]; ``` Configuration ------------- Finally, from the command line again, publish the default configuration file: ```bash 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`): | Setting name | Description | ENV variable | Default value | |-------------------|-------------------------------------------------------------------------------------------|----------------------------|-------------------------------------------| | url | URL for webhook from GitHub to your | GITHUB_HOOK_URL | /github/hook/ | | branch | Pulled repository branch on server | GITHUB_HOOK_BRANCH | master | | secret | GitHub webook secret code | GITHUB_HOOK_SECRET | null | | hooks.before | Array of commands to execute before composer actions (### is a separator). | GITHUB_HOOK_HOOK_BEFORE | [] | | hooks.composer | Composer update command (and dump-autoload). Set false to deactivate. | GITHUB_HOOK_HOOK_COMPOSER | composer install --no-dev | | hooks.migration | Artisan command for database migration. Set false to deactivate. | GITHUB_HOOK_HOOK_MIGRATION | php artisan migrate --force | | hooks.seed | Artisan command for database seeding. Set false to deactivate. | GITHUB_HOOK_HOOK_SEED | php artisan db:seed --force | | hooks.refresh | Artisan command for recreating database (migration and seeding). Set false to deactivate. | GITHUB_HOOK_HOOK_REFRESH | php artisan migrate:refresh --seed --force | | hooks.cache | Clear cache. Set false to deactivate. | GITHUB_HOOK_HOOK_CACHE | php artisan cache:clear | | hooks.view | Clear compiled views. Set false to deactivate. | GITHUB_HOOK_HOOK_VIEW | php artisan view:clear | | hooks.after | Array of commands to execute after rest of hooks (### is a separator). | GITHUB_HOOK_HOOK_AFTER | [] | | slack.sender | Name of sender of Slack notification | GITHUB_HOOK_SLACK_SENDER | GitHub Hook | | slack.channel | Channel where Slack notification will be posted | GITHUB_HOOK_SLACK_CHANNEL | | | slack.webhook_url | Slack webhook url. If empty, notification won't be send. | GITHUB_HOOK_SLACK_URL | | You can specify whole configuration in .env file: ```bash 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 `"`. 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: ```php <?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! You can also upload only service file `github-hook/src/Services/GitHubHookService.php` and then you need to change path to: ```php <?php require_once 'GitHubHookService.php'; ... ``` Changelog --------- 0.11.0 - Support Laravel 9.0, 10, and 11.x 0.9.0 - Support Laravel 8.0 0.8.1 - Add slack-notification-channel dependency 0.8.0 - Support Laravel 7.0 0.7.0 - Support Laravel 6.0 0.6.0 - Support Laravel 5.8 0.5.0 - Add before and after hooks 0.4.1 - Wrong package in Auto-Discovery definition. 0.4.0 - Support Package Auto-Discovery - `composer install --no-dev` instead of `composer update --no-scripts` as default command for composer hook 0.3.0 - cache and view clear commands 0.2.3 - ping request fixes 0.2.0 - 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 - created package - events - slack notification - hash verification Roadmap ------- * Asynchronous option * Comments * Unit tests! Credits ------- This package is developed by [HighSolutions](https://highsolutions.org), software house from Poland in love in Laravel.
