Skip to content

Latest commit

 

History

History
87 lines (54 loc) · 2.77 KB

README.md

File metadata and controls

87 lines (54 loc) · 2.77 KB
Raw

Trigger your Netlify build hooks with ease

Latest Version on Packagist Software License Build Status Quality Score Total Downloads

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 [email protected] instead of using the issue tracker.

Credits

License

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