Giter VIP home page Giter VIP logo

pivotal-tracker's Introduction

Pivotal Tracker notification channel for Laravel 5.3

Latest Version on Packagist Software License Build Status StyleCI SensioLabsInsight Quality Score Code Coverage Total Downloads

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 [email protected] 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.

pivotal-tracker's People

Contributors

atymic avatar freekmurze avatar nbourguig avatar

Watchers

 avatar  avatar  avatar  avatar

pivotal-tracker's Issues

Code review

Let me know when you're done with the code, tests and readme. I'll do a little code review and register your package on Packagist.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.