@mozaik/ext-travis

Mozaïk travis widgets

• installation
• client configuration
• widgets
  • BuildHistogram
  • BuildHistory
  • LatestRepositoryBuild
  • Repository
  • RepositoryBuildsStats

This branch contains code for the version compatible with Mozaïk v2, if you're looking for v1, please use mozaik-1 branch.

Demo

You can see a live demo of the widgets here

Install

Install extension:

# npm
npm install -S @mozaik/ext-travis
# yarn
yarn add @mozaik/ext-travis

Register client api

You should register extension's client by adding this to apis.js:

// …
Mozaik.registerApi('travis', require('@mozaik/ext-travis/client'))

Register widgets

You should register extension's widget by adding this to src/register_extensions.js:

import { Registry } from '@mozaik/ui'
import travis from '@mozaik/ext-travis'
// … 
Registry.addExtensions({
    travis,
})

Client Configuration

In order to use the Mozaïk travis extension, you must also configure its client. Configuration is loaded from environment variables.

env key	required	description
TRAVIS_API_TOKEN	yes	your personal travis API token

Widgets

BuildHistogram

Display travis repo build histogram (duration / build number / status)

parameters

key	required	description
owner	yes	repo owner
repository	yes	repo name
limit	no	limit displayed builds, default to 20
title	no	override default title, default to ${owner}/${repository} builds

usage

- extension:  travis
  widget:     BuildHistogram
  owner:      plouc
  repository: mozaik
  columns:    1
  rows:       1
  x:          0
  y:          0

BuildHistory

Display travis repo build history

parameters

key	required	description
owner	yes	repo owner
repository	yes	repo name
limit	no	limit displayed builds, default to 10
title	no	override default title, default to ${owner}/${repository} builds

usage

- extension:  travis
  widget:     BuildHistory
  owner:      plouc
  repository: mozaik
  columns:    1
  rows:       1
  x:          0
  y:          0

LatestRepositoryBuild

Show info about latest repository build for default branch

parameters

key	required	description
owner	yes	repo owner
repository	yes	repo name

- extension:  travis
  widget:     LatestRepositoryBuild
  owner:      plouc
  repository: mozaik
  columns:    1
  rows:       1
  x:          0
  y:          0

Repository

Display travis repository info

parameters

key	required	description
owner	yes	repo owner
repository	yes	repo name
title	no	override default title, default to ${owner}/${repository}

usage

- extension:  travis
  widget:     Repository
  owner:      plouc
  repository: mozaik
  columns:    1
  rows:       1
  x:          0
  y:          0

RepositoryBuildsStats

Show global stats about repository builds

parameters

key	required	description
owner	yes	repo owner
repository	yes	repo name
title	no	override default title, default to ${owner}/${repository} builds

usage

- extension:  travis
  widget:     RepositoryBuildsStats
  owner:      plouc
  repository: mozaik
  columns:    1
  rows:       1
  x:          0
  y:          0