laravel-notification-channels / pivotal-tracker
Pivotal Tracker Laravel Notifications driver
Requires
- php: >=5.6.4
- guzzlehttp/guzzle: ~6.0
- illuminate/events: ^5.3
- illuminate/notifications: ^5.3
- illuminate/support: ^5.3
Requires (Dev)
- mockery/mockery: ^0.9.5
- orchestra/testbench: ^3.3
- phpunit/phpunit: 4.*
This package is auto-updated.
Last update: 2019-09-26 23:42:31 UTC
README
This package makes it easy to create stories using pivotal-tracker with Laravel 5.3
Deprecated
This channel is deprecated and no longer maintained. As such, it will not be updated. If you would like to revive it, please create an issue in the new channels repo.
Contents
Installation
You can install the package via composer:
composer require laravel-notification-channels/pivotal-tracker
Usage
Now you can use the channel in your via() method inside the notification:
use NotificationChannels\PivotalTracker\PivotalTrackerChannel;
use NotificationChannels\PivotalTracker\PivotalTrackerMessage;
use Illuminate\Notifications\Notification;
class AnApplicationEvent extends Notification
{
public function via($notifiable)
{
return [PivotalTrackerChannel::class];
}
public function toPivotalTracker($notifiable)
{
return (new PivotalTrackerMessage('Something just occurred!'))
->description('This is a test for a notification via Pivotal Tracker.')
->type('bug')
->labels(['a_chore', 'just_a_test']);
}
}
In order to let your Notification know which pivotal-tracker user and project you are targeting, add the routeNotificationForpivotal-tracker method to your Notifiable model.
This method needs to return an array containing the access token of the authorized Pivotal Tracker user and the project ID to add the story to.
public function routeNotificationForpivotal-tracker()
{
return [
'token' => 'NotifiableToken',
'projectId' => 'Thepivotal-trackerProjectID'
];
}
Available methods
name('')
: Accepts a string value for the story name.description('')
: Accepts a string value for the story description.type('')
: Accepts a string value for the story type (feature|bug|chore)labels([])
: Accepts an array of strings representing the story labels.- Alternatively you can pass the labels as arguments.
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Security
If you discover any security related issues, please email nbourguig@gmail.com instead of using the issue tracker.
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.