rockkeeper/laravel-jira

Laravel5 service for Jira REST api to search and create issues

v0.4.1 2016-10-07 15:07 UTC

MIT

• Roland Bécsi
• Roman Wollenburg

• laravel
• jira
• atlassian

README

Easy access Jira rest api in Laravel5.

• Installation and Requirements
• Searching issues
• Creating issues
• Editing issues

Installation and Requirements

composer require rockkeeper/laravel-jira

Afterwards, run composer update from your command line.

Then, update config/app.php by adding an entry for the service provider.

'providers' => [
    // ...
    Univerze\Jira\JiraServiceProvider::class,
];

'aliases' => [
  	// ...
  	'Jira' => Univerze\Jira\Facade\JiraFacade::class,
];

Finally, from the command line again, run php artisan vendor:publish to publish the default configuration file to config/jira.php.

Searching issues

The search method will take the jql query string:

$response = Jira::search( 'project = YourProject AND labels = somelabel' );

You can build and test the jql beforehand if you go to your Jira site Issues > Search for Issues > Advanced Search.

Further information can be found on JIRA documentation - search issues

NOTE jql parameter is already included in the payload

Creating issues

$issue = Jira::create( array(
    'project'     => array(
        'key' => 'YourProject'
    ),
    'summary'     => 'This is the summary',
    'description' => 'Description here',
    'issuetype'   => array(
        'name' => 'Bug'
    )
) );

Further information can be found on JIRA documentation - create issue

NOTE fields parameter is already included in the payload

Editing issues

Jira::update( 'ISSUE-1234', array(
    'description' => 'this is my new description'
) );

In this case the JIRA api will return "204 - No Content" instead of issue details.

Further information can be found on JIRA documentation - edit issue

NOTE fields parameter is already included in the payload

Released under the MIT License. See the LICENSE file for details.