Skip to content

An app to transform payload data from CircleCi and then push to a geckoboard text widget to display CI job status

License

Notifications You must be signed in to change notification settings

feedmypixel/circleci-geckoboard-status

Repository files navigation

CircleCi geckoboard text widget

Build Status

An app that transforms payload data from CircleCi and then pushes information to a geckoboard text widget. The geckoboard text widget displays the status of the CircleCi job for the specified repository and branch. It also shows the last person who committed to this branch.

Table of contents

Screen shots

Passed

An example of a successful CircleCi job on develop branch

CircleCi geckoboard text widget example

Failure

An example of a failed CircleCi job on master branch

CircleCi geckoboard text widget failure example

Environment variables

Name Description
GECKO_BOARD_API_KEY geckoboard API key
GECKO_BOARD_WIDGET_URL geckoboard text widget url
REPO_NAME The repository name of your CircleCi job
BRANCH The branch name you wish to show results for
PORT The applications port, defaults to 3048

Development

Setup

Recommended setup

To install multiple versions of Node.js, you may find it easier to use a node version manager

To install dependencies

$ npm i

Running

To start the application

$ npm start

CSS styles

You will find an example styles.sass file in /widget-example. Here you can write custom styles for your CircleCi geckoboard widget.

To create the styles.css file run:

$ npm run sass

You can then upload the styles.css file to your geckboard dashboard via settings > Customize apperance.

Tests

To run tests

$ npm test

Linting

To run linting

$ npm run lint

Hosting

Upload this application to your favourite hosting platform.

CircleCi webhook

Setup a webhook on you CircleCi Job that sends its payload to this application. Add the following (with your applications url) to the bottom of your repositories config.yaml

notify:
  webhooks:
    - url: <application-url>

About

An app to transform payload data from CircleCi and then push to a geckoboard text widget to display CI job status

Resources

License

Stars

Watchers

Forks

Packages

No packages published