Build monitor

Now the world is remote, do you struggle to keep track of you builds?

Do you want to decouple your build monitor from your machine?

Get yourself a raspberry pi, some LEDs and clone this repo!

To run

• Make help make
• Setup make bootstrap
• Test make test
• Debug make debug
• Publish make publish
• Install make install-monitor

Install

To install directly from github:

Latest

pip3 install git+https://github.com/worthington10TW/gpio-build-monitor#egg=monitor

Run on your raspberry pi

When running on your machine the mock GPIO board is used, this is disabled when running optimized.

First make sure the module is installed.

Install the GPIO package pip3 install Rpi.GPIO

Then run the module.

python3 -O -m monitor -conf integrations.json

Signals

• Blue light: Fetching data
• Green light: All builds pass
• Red light: Any builds fail
• Yellow pulse: Any builds are running

Setup

Example setup can be found here: src/integrations.json

Config is passed using the -conf argument variable

{
    "poll_in_seconds": 30,
    "integrations": [
            {
                "type": "",
                "username": "",
                "repo": "",
                "excluded_workflows": [ "" ]
            }
        ]
}

Current integrations

• CircleCI
• GitHub Actions

Personal API tokens are read from environment variables

export GITHUB_TOKEN=<TOKEN>
export CIRCLE_CI_TOKEN<TOKEN>

Pin setup

• Pin constants can be found in src/gpio/constants.py

My build

Shopping list

The monitor

• Raspberry Pi Zero
• SD card
• Resistor kit
• LED kit
• Cables
• Breadboard
• Shrink cables

Useful kit

• Anti-static band
• Rubber mat
• Soldering iron
• Multimeter

The housing

• Frame

TODO

• Feedback when connection is unsuccessful.
• Allow multiple access tokens for integrations.
• Allow default pin overrides
• Enhanced CLI functionality, possibly with click
• GoCD integration
• Concourse integration
• Travis integration