developmint/netlify-build-hook

Trigger your Netlify build hooks with ease

v1.0 2019-08-16 21:53 UTC

Requires

• php: ^7.0
• guzzlehttp/guzzle: ^6.3

Requires (Dev)

• phpunit/phpunit: ~6.0

MIT

• Alexander Lichter

• build
• HOOK
• webhook
• netlify
• buildhook

README

This package provides a lightweight class to trigger your Netlify build hooks properly.

Installation

You can install the package via composer:

composer require developmint/netlify-build-hook

Usage

You must pass the following things to the constructor of Developmint\NetlifyBuildHook\NetlifyBuildHook.

• A Guzzle client
• The unique Identifier of you build hook (the last part of the build hook URL).

The last two arguments are optional:

• A custom title shown on Netlify
• Another branch the deploy should use

$client = new \GuzzleHttp\Client();
$id = 'XXX'
$hook = new \Developmint\NetlifyBuildHook\NetlifyBuildHook($client, $id);

// Alternatively

// With title
$hook = new \Developmint\NetlifyBuildHook\NetlifyBuildHook($client, $id, 'My custom title');

// With branch
$hook = new \Developmint\NetlifyBuildHook\NetlifyBuildHook($client, $id, null, 'other-branch');

// With everything
$hook = new \Developmint\NetlifyBuildHook\NetlifyBuildHook($client, $id, 'My custom title', 'branch-name');

Get stats for a package of your choice

Trigger the hook with the corresponding triggerfunction of your class instance (from above). If a problem occurs, a RequestException will be thrown.

$hook->trigger();

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

Testing wasn't entirely possible as mocking the hooks doesn't help anyone and test hooks are not available.

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Alexander Lichter
• All Contributors

License

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