Git Product home page Git Product logo

bkboard's Introduction

bkboard

NPM version build status Downloads js-standard-style

A Buildkite build report dashboard in terminal and web, or anywhere.

bkboard

Installation

$ npm install bkboard --save

Usage in browser

var bkboard = require('bkboard')

/**
 * Get the builds data from a pipeline
 * @param  {String} The token string
 * @param  {Object} The opts object contains 'from', 'to', 'org', 'pipeline'
 * @param  {Function}    Callback function with `err, builds`
 */
bkboard(token, opts, function (err, builds) {
  if (err) {
    console.log('err', err)
    return
  }

  drawBoard(builds)
})

Example opts object:

{
  from: '2016-03-13T00:00:00Z',
  to: '2016-03-18T00:00:00Z',
  org: 'xxx',
  pipeline: 'xxx'
}

Usage from terminal

$ npm install bkboard -g

You can get Buildkite api_token from https://buildkite.com/user/api-access-tokens and set it with git config or pass it to process.env.BUILDKITE_API_KEY.

Note: Please make sure you have the Read Builds (read_builds) permission enable to be able to read builds from Buildkite API.

Permission to list and retrieve details of builds

Exampe

$ bkboard --from='2016-03-13T00:00:00Z' --to='2016-03-16T00:00:00Z' --org='$ORG' --pipeline='$PIPELINE'

License

MIT

bkboard's People

Contributors

fraserxu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.