{"id":15369088,"url":"https://github.com/developit/bamboo-status-svg","last_synced_at":"2025-04-15T13:43:03.912Z","repository":{"id":17535921,"uuid":"20338457","full_name":"developit/bamboo-status-svg","owner":"developit","description":"A web service that generates build badges for Bamboo plans.","archived":false,"fork":false,"pushed_at":"2017-05-09T14:47:04.000Z","size":6,"stargazers_count":10,"open_issues_count":0,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T11:16:05.273Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/developit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-30T18:27:14.000Z","updated_at":"2023-09-25T07:42:01.000Z","dependencies_parsed_at":"2022-07-26T18:15:19.009Z","dependency_job_id":null,"html_url":"https://github.com/developit/bamboo-status-svg","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/developit%2Fbamboo-status-svg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/developit%2Fbamboo-status-svg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/developit%2Fbamboo-status-svg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/developit%2Fbamboo-status-svg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/developit","download_url":"https://codeload.github.com/developit/bamboo-status-svg/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248490278,"owners_count":21112718,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-01T13:34:05.715Z","updated_at":"2025-04-15T13:43:03.888Z","avatar_url":"https://github.com/developit.png","language":"JavaScript","readme":"# bamboo-status-svg [![NPM Version](http://img.shields.io/npm/v/bamboo-status-svg.svg)](https://npmjs.com/package/bamboo-status-svg)\n\nA library and/or service that produces SVG badges for Bamboo build plans.\n\n\n\nExample\n-------\n![Example Build Status](http://f.cl.ly/items/2w3v1b2u350D0318052f/Screen%20Shot%202014-05-30%20at%202.01.17%20PM.png)\n\n\nAs a Library\n------------\n\n*bamboo-status-svg* is available in the NPM registry: ([bamboo-status-svg](http://npm.im/bamboo-status-svg)).\n\n**Example library usage:**\n\n\n```JavaScript\nvar status = require('bamboo-status-svg');\nvar options = {\n\tbamboo : 'https://bamboo.asterisk.org',\n\tport : 3001\n};\n\nstatus.start(options, function(err) {\n\tconsole.log('Running.');\n});\n```\n\n\u003e\t**Configuration Options:**  \n\u003e\t**`bamboo`**  \n\u003e\tThe bamboo instance URL to connect to.  \n\u003e\t*Example: `https://bamboo.example.org/`*  \n\u003e\n\u003e\t**`port`**  \n\u003e\tThe port to start the server on.  \n\u003e\t*Defaults to the `PORT` environment variable.*  \n\u003e\n\u003e\t**`index`**  \n\u003e\tIf `true`, requests for `/` return a JSON description  \n\n\nAs a Service\n------------\nOut of the box, you can run `bamboo-status-svg` as a standalone service:  \n\n```bash\n# get the code:\ngit clone git@github.com:developit/bamboo-status-svg.git\ncd bamboo-status-svg\n\n# install dependencies\nnpm install\n\n# run the server\nPORT=8080 BAMBOO=bamboo.example.org npm start\n```\n\n\u003e\t**Supported Environment Variables:**  \n\u003e\t**`BAMBOO`**  \n\u003e\tThe bamboo instance URL to connect to. *Example: `bamboo.example.org`*  \n\u003e\n\u003e\t**`PORT`**  \n\u003e\tThe port to start the server on.\n\u003e\n\u003e\t**`INDEX`**  \n\u003e\tIf `true`, requests for `/` return a JSON description  \n\n\nDeploy\n------\nYou can easily deploy `bamboo-status-svg` as an app without modifying it at all.\n\n```bash\n# get the code:\ngit clone git@github.com:developit/bamboo-status-svg.git\ncd bamboo-status-svg\n\n# set up a heroku app:\nheroku login\nheroku create\n\n# Configure the bamboo instance to point to\nheroku config:set BAMBOO=bamboo.example.org\n\n# Deploy\ngit push heroku master\n```\n\n\nStatus Image URLs\n-----------------\nOnce running/deployed, you can get a Bamboo plan status image by passing the required information in the URL like:  \n`http://HOST:PORT/status/[PLAN_NAME]`  \n*Example:*  \n`http://bamboo-status-svg.herokuapp.com/status/BAM-BO0`  \n\n\u003e\t**Tip:** *Check Travis-CI's documentation on [status images](http://docs.travis-ci.com/user/status-images/) for placing these badges into a README.*\n\n\nCredits\n-------\nbamboo-status-svg was originally based on [bamboo-status](https://github.com/chamerling/bamboo-status), by [Christophe Hamerling](http://chamerling.github.io/).\n\n\nLicense\n-------\n**[MIT](http://mths.be/mit)**\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevelopit%2Fbamboo-status-svg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevelopit%2Fbamboo-status-svg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevelopit%2Fbamboo-status-svg/lists"}