schantldev / git-webhook
An easy way to update your application using Github's webhooks. No manual deploy required.
Requires
- php: ^8.2
- illuminate/support: ^11.0|^12.0
Requires (Dev)
- orchestra/testbench: ^9.0|^10.0
- phpunit/phpunit: ^11.0
README
An easy way to update your application using Github webhooks. No manual deploy required.
This package sets up a route that you can use for your Github webhooks. You can set a secret and define the URL of the route. The pacakge will publish a deploy script that you can customize to fit your needs.
Installation
You can install the package via composer:
composer require schantldev/git-webhook
After that, publish the files using
php artisan vendor:publish
Ensure the deployment script is executable by running
chmod +x /storage/git-webhook/git_deploy.sh
The package will queue the command and run it in the background. Ensure you have a proper queue (eg. database driver) set up, otherwise the deployment script might not work.
Usage
- Define the webhook URL you want to use in the
git-webhook.phpconfig file - Define a secret if necessary
- Activate the webhook inside your repository settings
Contributing
Everybody is welcome to contribute towards this git webhook package.
Security
If you discover any security related issues, please email office@schantl.io instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.