https://github.com/minduca/gecko-ci
A lightweight build monitor that handles IoT gadgets and brings CI feedbacks to the real world
https://github.com/minduca/gecko-ci
build build-automation build-management build-monitor ci continuous-delivery continuous-deployment continuous-integration gecko-ci iot lifx light-bulbs monitor nodejs nodejs-modules tfs typescript xtreme-feedback
Last synced: 4 months ago
JSON representation
A lightweight build monitor that handles IoT gadgets and brings CI feedbacks to the real world
- Host: GitHub
- URL: https://github.com/minduca/gecko-ci
- Owner: minduca
- License: gpl-3.0
- Created: 2016-08-10T00:31:38.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-04-10T02:02:09.000Z (about 9 years ago)
- Last Synced: 2026-01-24T05:43:14.401Z (5 months ago)
- Topics: build, build-automation, build-management, build-monitor, ci, continuous-delivery, continuous-deployment, continuous-integration, gecko-ci, iot, lifx, light-bulbs, monitor, nodejs, nodejs-modules, tfs, typescript, xtreme-feedback
- Language: TypeScript
- Homepage:
- Size: 195 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# gecko-ci
Gecko-ci is a lightweight plugin that improves engagement of team members by providing physical feedback of the status of the build. It creates a link between a build server and smart RGB light bulbs, displaying specific colors for each build status.
Gecko-ci currently supports only **TFS** as build server and **[LIFX Bulbs](http://www.lifx.com/)** as extreme feedback device.
[](https://david-dm.org/minduca/gecko-ci)
[](https://www.npmjs.com/package/gecko-ci)
[](http://waffle.io/minduca/gecko-ci)
## Build Status Colors
When the build status change, the color of the light bulb changes accordingly.
| Status change | Color |
| :------------------------ | :------ |
| `buildSucceeded` | Green |
| `buildPartiallySucceeded` | Orange |
| `buildFailed` | Red |
## Install
**node.js** & **bower**
```javascript
npm install gecko-ci --save
bower install gecko-it --save
```
## Quick Start
Define one or more connections to your build server(s), create one or more build monitors associated to these connections and link each monitor to light bulbs that will display the status of the build.
**node.js**
```javascript
let gecko = require("gecko-ci")
```
**browser**
```javascript
let gecko = window.$gecko
```
```javascript
let monitor = gecko.watchBuilds({
connections: [
{
name: "my connection 01",
technology: "tfs",
collection: "DefaultCollection",
server: "https://foo.visualstudio.com/",
user: "foo@gmail.com",
personalToken: "xxxXXXxxXXXXxxXXXXxxxXXXXxxXXXXxxxxxXXXXxxx"
}
],
buildMonitors: [
{
name: "my monitor 01",
teamProject: "MyTeamProject",
connectionName: "my connection 01"
}
],
lightBulbs: [
{
name: "my bulb config 01",
technology: "lifx",
buildMonitorsNames: ["my monitor 01"],
selector: "all",
personalToken: "yyyyYYYYyyYYyyyYYYyyyyyyYYYYyyyyyYYYyyyyyyYYyyyy"
}
]
});
```
To stop the application, you simply do
```javascript
monitor.stopWatchingBuilds();
```
## Options
#### `connections`
Array of connections to one or more build servers.
| Attribute | Type | Supported values | | Description |
| :--------------- | :------: | :--------------- | :------: | :---------- |
| `name` | *String* | - | Required | Unique name (id) of the connection. |
| `technology` | *String* | "tfs" | Required | Technology of the build server. TFS is currently the only build server supported. |
| `collection` | *String* | - | Required | Name of the Team Project Collection on TFS. |
| `server` | *String* | - | Required | Address of the build server. |
| `user` | *String* | - | Required | User account to authenticate to the build server via REST api. |
| `personalToken` | *String* | - | Required | App token for authorizations on the build server. For TFS, take a look at [Create personal access tokens to authenticate access](https://www.visualstudio.com/en-us/docs/integrate/get-started/auth/overview). Only the scope **Build (read)** is required. The token supplied must be associated to the value supplied on `user`. |
#### `buildMonitors`
Array of monitors that connect to build servers and check the build status
| Attribute | Type | Supported values | | Description |
| :--------------- | :------: | :--------------- | :------: | :---------- |
| `name` | *String* | - | Required | Unique name (id) of the build monitor. |
| `teamProject` | *String* | - | Required | Name of the Team Project on TFS. |
| `connectionName` | *String* | - | Required | id of the connection that will be used by the monitor. it must be an existing `options.connections[].name`. |
| `definitions`
`queues`
`type`
`requestedFor`
`reasonFilter`
`tagFilters`
`propertyFilters`
| *String* | - | Optional | TFS parameters that are also supported. Check the [TFS Builds api](https://www.visualstudio.com/en-us/docs/integrate/api/build/builds) for the MSDN documentation of these parameters. The TFS api documentation contains many other parameters that aren't listed here, but gecko-ci will handle them. Although it's strongly recommended that you don't override these arguments that aren't listed here, you can play with them at your own risk. |
#### `lightBulbs`
Array of light bulbs that display the status of one or more build monitors
| Attribute | Type | Supported values | | Description |
| :--------------- | :------: | :--------------- | :------: | :---------- |
| `name` | *String* | - | Required | Unique name (id) of the light bulb. |
| `technology` | *String* | "lifx" | Required | Technology of the light bulb. LIFX is currently the only bulb supported. |
| `buildMonitorsNames` | *String[]* | - | Required | array of ids of build monitors that are linked to this light bulb configuration. it must be an existing `options.buildMonitors[].name`. |
| `selector` | *String* | - | Required | A LIFX selector. Check the [LIFX selectors](https://api.developer.lifx.com/docs/selectors) for the documentation of this argument. |
| `personalToken` | *String* | - | Required | App token for authorizations on the LIFX server. Check the [Account settings](https://cloud.lifx.com/settings) in order to generate a token. |
## License
[GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.html)