https://github.com/developit/bamboo-status-svg
A web service that generates build badges for Bamboo plans.
https://github.com/developit/bamboo-status-svg
Last synced: 8 months ago
JSON representation
A web service that generates build badges for Bamboo plans.
- Host: GitHub
- URL: https://github.com/developit/bamboo-status-svg
- Owner: developit
- Created: 2014-05-30T18:27:14.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2017-05-09T14:47:04.000Z (over 8 years ago)
- Last Synced: 2025-04-10T11:16:05.273Z (9 months ago)
- Language: JavaScript
- Size: 5.86 KB
- Stars: 10
- Watchers: 2
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bamboo-status-svg [](https://npmjs.com/package/bamboo-status-svg)
A library and/or service that produces SVG badges for Bamboo build plans.
Example
-------
As a Library
------------
*bamboo-status-svg* is available in the NPM registry: ([bamboo-status-svg](http://npm.im/bamboo-status-svg)).
**Example library usage:**
```JavaScript
var status = require('bamboo-status-svg');
var options = {
bamboo : 'https://bamboo.asterisk.org',
port : 3001
};
status.start(options, function(err) {
console.log('Running.');
});
```
> **Configuration Options:**
> **`bamboo`**
> The bamboo instance URL to connect to.
> *Example: `https://bamboo.example.org/`*
>
> **`port`**
> The port to start the server on.
> *Defaults to the `PORT` environment variable.*
>
> **`index`**
> If `true`, requests for `/` return a JSON description
As a Service
------------
Out of the box, you can run `bamboo-status-svg` as a standalone service:
```bash
# get the code:
git clone git@github.com:developit/bamboo-status-svg.git
cd bamboo-status-svg
# install dependencies
npm install
# run the server
PORT=8080 BAMBOO=bamboo.example.org npm start
```
> **Supported Environment Variables:**
> **`BAMBOO`**
> The bamboo instance URL to connect to. *Example: `bamboo.example.org`*
>
> **`PORT`**
> The port to start the server on.
>
> **`INDEX`**
> If `true`, requests for `/` return a JSON description
Deploy
------
You can easily deploy `bamboo-status-svg` as an app without modifying it at all.
```bash
# get the code:
git clone git@github.com:developit/bamboo-status-svg.git
cd bamboo-status-svg
# set up a heroku app:
heroku login
heroku create
# Configure the bamboo instance to point to
heroku config:set BAMBOO=bamboo.example.org
# Deploy
git push heroku master
```
Status Image URLs
-----------------
Once running/deployed, you can get a Bamboo plan status image by passing the required information in the URL like:
`http://HOST:PORT/status/[PLAN_NAME]`
*Example:*
`http://bamboo-status-svg.herokuapp.com/status/BAM-BO0`
> **Tip:** *Check Travis-CI's documentation on [status images](http://docs.travis-ci.com/user/status-images/) for placing these badges into a README.*
Credits
-------
bamboo-status-svg was originally based on [bamboo-status](https://github.com/chamerling/bamboo-status), by [Christophe Hamerling](http://chamerling.github.io/).
License
-------
**[MIT](http://mths.be/mit)**