thijskok / jira-client

The TestMonitor Jira Client.

TestMonitor Jira Client

This package provides a very basic, convenient, and unified wrapper for the PHP JIRA Rest Client.

Table of Contents

• Installation
• Usage
• Examples
• Tests
• Changelog
• Contributing
• Credits
• License

Installation

To install the client you need to require the package using composer:

$ composer require testmonitor/jira-client

Use composer's autoload:

require __DIR__.'/../vendor/autoload.php';

You're all set up now!

Usage

You'll have to instantiate the client using your credentials:

$jira = new \TestMonitor\Jira\Client('https://myjira.atlassian.net', 'username', token');

Next, you can start interacting with Jira.

Examples

Get a list of Jira projects:

$projects = $jira->projects();

Or creating an issue, for example (using type 'Bug' and project key 'PROJ'):

$issue = $jira->createIssue(new \TestMonitor\Jira\Resources\Issue([
    'summary' => 'Some issue',
    'description' => 'A better description',
    'type' => 'Bug',
]), 'PROJ');

Tests

The package contains integration tests. You can run them using PHPUnit.

$ vendor/bin/phpunit

Changelog

Refer to CHANGELOG for more information.

Contributing

Refer to CONTRIBUTING for contributing details.

Credits

• Thijs Kok - Lead developer - ThijsKok
• Stephan Grootveld - Developer - Stefanius
• Frank Keulen - Developer - FrankIsGek
• Muriel Nooder - Developer - ThaNoodle

License

The MIT License (MIT). Refer to the License for more information.