包简介

Laravel Git Hook

README 文档

README

Install

Via Composer

$ composer require webklex/laravel-git-hook

Setup

Add the service provider to the providers array in config/app.php.

'providers' => [
    Webklex\GitHook\Providers\LaravelServiceProvider::class,
];

Publishing

You can publish everything at once

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 for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email github@webklex.com instead of using the issue tracker.

Credits

Webklex
All Contributors

License

The MIT License (MIT). Please see License File for more information.

webklex/laravel-git-hook 适用场景与选型建议

webklex/laravel-git-hook 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 1.16k 次下载、GitHub Stars 达 17，最近一次更新时间为 2017 年 03 月 04 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「git」「HOOK」「laravel」「deployment」「git hook」「webklex」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 webklex/laravel-git-hook 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 webklex/laravel-git-hook 我们能提供哪些服务？

定制开发 / 二次开发

基于 webklex/laravel-git-hook 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 webklex/laravel-git-hook 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

xheaven/composer-git-hooks 3

Easily manage git hooks in your composer config

professional-wiki/external-content 9

MediaWiki extension that allows embedding external content, specified by URL, into your wiki pages

cytopia/check_git 10

Nagios plugin to verify a git repository.

morningmedley/hook 0

A system for organizing WordPress hooks

smoren/mushroom-hook-manager 0

Composer plugin for running post-install/post-update scripts of your project's dependencies

namelesscoder/gizzle 8

GitHub Webhook Listener with plugin-based API for creating your own triggerered actions

webklex/laravel-git-hook

包简介

关键字：