peterjmit/bamboo-api-client

A REST API client for Atlassian Bamboo

Bamboo REST API client

An API client consuming the [REST resources][1] made available for Atlassian's CI software - Bamboo, _(*1)

Installation

Add this line to your composer.json file, and run composer update, _(*2)

"peterjmit/bamboo-api-client": "~0.1.0"

Usage

Create an API client using http basic authentication, _(*3)

<?php
use  Peterjmit\Bamboo\Bamboo;

$bamboo = Bamboo::create('bamboo.com', 'username', 'password');

Specify an API version, _(*4)

<?php
$bamboo = Bamboo::create('bamboo.com', 'username', 'password', 1);

Methods

Get all build results, _(*5)

<?php
$bamboo->getAllBuildResults();

Get build results for a plan, _(*6)

<?php
$bamboo->getPlanResults('AN', 'EXAMPLE');

Get build results for a plan branch, _(*7)

<?php
$bamboo->getPlanBranchResults('AN', 'EXAMPLE', 'my-cool-feature-branch');

Get plan information for a specific branch, _(*8)

<?php
$bamboo->getPlanBranch('AN', 'EXAMPLE', 'my-cool-feature-branch');

Todo

• Implement all [endpoints/resources][1]
• Create objects to represent resources
• Utilize "expand" functionality in bamboo
• Use HATEOS links to load relations to returned objects

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request