Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webklex/laravel-git-hook
Automatic git deployment for Laravel
https://github.com/webklex/laravel-git-hook
auto-deployment deployment git git-hook laravel
Last synced: about 1 month ago
JSON representation
Automatic git deployment for Laravel
- Host: GitHub
- URL: https://github.com/webklex/laravel-git-hook
- Owner: Webklex
- License: mit
- Created: 2017-03-04T17:29:52.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-08T18:40:02.000Z (about 7 years ago)
- Last Synced: 2024-07-06T02:59:49.146Z (7 months ago)
- Topics: auto-deployment, deployment, git, git-hook, laravel
- Language: PHP
- Size: 23.4 KB
- Stars: 17
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Git hook deployment made for Laravel
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-travis]][link-travis]
[![Total Downloads][ico-downloads]][link-downloads]
## Install
Via Composer
``` bash
$ composer require webklex/laravel-git-hook
```
## Setup
Add the service provider to the providers array in `config/app.php`.
``` php
'providers' => [
Webklex\GitHook\Providers\LaravelServiceProvider::class,
];
```
## Publishing
You can publish everything at once
``` php
php artisan vendor:publish --provider="Webklex\GitHook\Providers\LaravelServiceProvider"
```
## Usage
This library is designed to handle the automatic deployment by git hooks
as simple as possible. There isn't much todo to get started: just add the
Provider and edit the `config/git-hook.php` file to make it fit your needs.
Custom configuration can be made within the `config/git-hook.php` file:
| Parameter | Default | Options | Description |
| ------------------ | :-------------------------------: | :---------------------------------------: | --------------------------------------------------------------------------------------------------------: |
| email_recipients | `[]` | `[['name' => '', 'address' => ''], ...]` | Get notified by mail. Just add your credentials |
| email_email_sender | `['address' => '', 'name' => '']` | `['address' => '', 'name' => '']` | Specify a custom email sender address |
| repo_path | `null` | Leave empty to auto detect the vcs root | Perhaps your repository is somehow specially structured, if that's the case, specify your repository path |
| allowed_sources | `[]` | `['192.168.1.1', '192.168.1.2', ...]` | If you want to secure the deployment process a bit more, whitelist the remote repository IPs |
| remote | `origin` | | Your remote branch name |
| git_path | `/usr/bin/git` | | Where is the git binary located |
| logfile | `git-hook` | | Name of the logfile. It will be stored under storage/logs |
| service | `github` | `github`, `gitbucket`, `gitlab` | Define your remote git service. This is required to identify the payload |
| url | `git-hook` | | Define the deployment url. Keep in mind, that the given parameter will be added to your app.url |
| before_pull | `[]` | `['down', ['cmd', ['arg1' => 1]]]` | If you have any commands that have to be called before a pull event, specify them here |
| after_pull | `[]` | `['cmd', ['cmd1', ['arg1' => 1]], 'up']` | If you have any commands that have to be called after a pull event, specify them here |
If you are concerned someone could guess it, use a more cryptic url such as: `JHFUjhd67567JHFGhsd78236784wegfJHFghdgf`
## Potential problems:
Please make sure your `www-data` user can actually perform a git pull on the server without
having to enter a password:
so you might want to take a look at ssh-keys or something similar
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ composer test
```
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Webklex][link-author]
- All Contributors
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/Webklex/laravel-git-hook.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/Webklex/laravel-git-hook/master.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/Webklex/laravel-git-hook.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/Webklex/laravel-git-hook.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/Webklex/laravel-git-hook.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/Webklex/laravel-git-hook
[link-travis]: https://travis-ci.org/Webklex/laravel-git-hook
[link-scrutinizer]: https://scrutinizer-ci.com/g/Webklex/laravel-git-hook/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/Webklex/laravel-git-hook
[link-downloads]: https://packagist.org/packages/Webklex/laravel-git-hook
[link-author]: https://github.com/webklex