PHP download

Download the PHP package 8ctopus/git-hook without Composer

On this page you can find all versions of the php package 8ctopus/git-hook. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of 8ctopus/git-hook

Informations about the package git-hook

git hook

code coverage badge lines of code

Automate deployment for git pushes to GitHub and Gitea using webhooks.

Automatically push your git repository changes to any website.

demo

git clone the repository
start a local php development server: php -S localhost:80 demo.php
run the curl request which simulates the webhook request

install

composer require 8ctopus/git-hook

GitHub usage

Create a new page such as this one in a public part of your website (in this example https://example.com/api/myhook/index.php)
In the GitHub project, go to Settings > Webhooks > Add webhook.
Set Payload URL to https://example.com/api/myhook/
Set Content type to application/json
Set Secret using a strong password (same as in the script SAME_SECRET_KEY_AS_IN_GITHUB_ADMIN)
Set Just the push event
Check Active
Click Add Webhook
Once added, click on it and scroll to the bottom to check the first delivery. If the first delivery succeeded you are all set. If it failed, review the response error and click Redeliver once you think you fixed it.

Note: Also read the important notes below.

Gitea usage

Create a new page such as this one in a public part of your website (in this example https://example.com/api/myhook/index.php)
update your gitea configuration in order to allow to send webhooks to your domain
In the Gitea project, go to Settings, select Gitea from Add webhook.
Set Target URL to https://example.com/api/myhook/
Set HTTP Method to POST
Set Post Content Type to application/json
Set Secret using a strong password (same as in the script SAME_SECRET_KEY_AS_IN_GITEA_ADMIN)
Set Trigger On to Push Events
Set Branch filter to master or any branch you want to trigger the script
Check Active
Click Add Webhook
Once added, click on it and scroll to the bottom and click Test Delivery
If the delivery succeeds you are all set. If it fails, go to the server and check the log.

important notes for both github and gitea

Note: for git pulls to work using user www-data (the apache typically runs under that user), you probably will need to:

make sure the upstream is set, so git knows where to pull from
make sure user www-data is the owner of the git repository. If not, you will get the error message

Note: If you are concerned about weaker security, you can consider giving user www-data permissions to run git as another user such as ubuntu. This way, your webserver files can be owned by ubuntu and www-data can only read them. I'm not security specialist, so be warned.

Note: for git pulls to work using user www-data (the apache processes typically run under that user), you probably will need to:

~~- include the user and password (must be url encoded) inside the git remote url~~

callbacks

Callbacks can be implemented per command or for every command:

Both callbacks have the same signature

Returning false aborts the deployment

debugging

The deployment script can be easily debugged locally using ngrok.

run ngrok ngrok http 80
update the Payload URL for Github or Target URL for Gitea to the ngrok address, similar to this one https://6daf-31-218-13-51.ngrok-free.app
run the php local server php -S localhost:80 demo.php
start visual studio code debugging and set a breakpoint in demo.php
resend the webhook request

clean code

composer fix(-risky)

phpstan

composer phpstan

phpmd

composer phpmd

All versions of git-hook with dependencies

PHP Build Version

Package Version

Version 3.0.0 Release 07. Mar 2024
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of git-hook from vendor 8ctopus

No informations.

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package 8ctopus/git-hook contains the following files

Loading the files please wait ....