Not Parents' Money

    bkboard

    0.0.3 • Public • Published

    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

    Install

    npm i bkboard

    DownloadsWeekly Downloads

    0

    Version

    0.0.3

    License

    MIT

    Last publish

    Collaborators

    • fraserxu