An open API service indexing awesome lists of open source software.

https://github.com/peridot-php/peridot-yo-plugin

Notify the right people when tests pass or fail via the world's simplest messaging platform - Yo
https://github.com/peridot-php/peridot-yo-plugin

Last synced: about 2 months ago
JSON representation

Notify the right people when tests pass or fail via the world's simplest messaging platform - Yo

Awesome Lists containing this project

README

          

Peridot Yo Plugin
=================

[![Build Status](https://travis-ci.org/peridot-php/peridot-yo-plugin.png)](https://travis-ci.org/peridot-php/peridot-yo-plugin)

Notify the right people when tests pass or fail, via the world's simplest messaging service [Yo](http://www.justyo.co/)

This is a plugin for PHP's event driven testing framework [Peridot](http://peridot-php.github.io/)

## Usage

We recommend adding this plugin to your project via composer:

```
$ composer require --dev peridot-php/peridot-yo-plugin:~1.0
```

Using the plugin is easy via your [peridot.php](http://peridot-php.github.io/#plugins) file:

```php
setBehavior(YoPlugin::BEHAVIOR_ON_PASS);
};
```

### BEHAVIOR_ON_PASS

Receive Yo notifications when the test suite passes.

### BEHAVIOR_ON_FAIL

Receive Yo notifications when the test suite fails. This is the default behavior.

### BEHAVIOR_ALWAYS

Receive Yo notifications when the test suite finishes running.

## Running tests

Tests were written using [Peridot](http://peridot-php.github.io/). You can run them like so:

```
$ vendor/bin/peridot specs/
```

## Contributing

Pull requests, issues, and feedback are of course always welcome.