A GoCD dashboard for showing pipeline status at a glance
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
gocd_dashboard
.gitignore
LICENSE
MANIFEST.in
README.md
package.json
setup.py
tox.ini

README.md

gocd-dashboard

A GoCD dashboard for showing pipeline status at a glance. Details about each pipeline and all of it's materials (even grandparents!) are collected to show the authors of commits that caused each pipeline to run.

Screenshot

Usage

Requirements: Python 3.3 or above, the gocd_dashboard python package (and it's dependencies).

gocd-dashboard run --host localhost --port 5000

You will need to create a JSON configuration file that describes your GoCD server. The server will look config.json in the current directory, or use the path of the GOCD_DASHBOARD_CONFIG environment variable.

{
  "gocd": {
    "server": "https://gocd.example.com",
    "username": "guest",
    "password": "guest"
  },
  "groups": [
    {
      "name": "example",
      "pipelines": [
        "pipeline-a",
        "pipeline-b"
      ]
    }
  ]
}

Pipelines will be colored depending on their status:

  • Failed: red.
  • Running: yellow.
  • Passed: white (green if the entire group has passed).

Development

Requirements: Python 3.3 or above, the virtualenv python package, NodeJS and the npm package manager.

Install the module into a Python virtualenv in development mode:

pip install -e .

Install a Sass compiler and materialize.css:

npm install

Compile CSS files using node-sass:

./node_modules/.bin/node-sass --watch gocd_dashboard/static --output gocd_dashboard/static

Run the development server:

FLASK_DEBUG=1 gocd-dashboard run

License

Released under the MIT licence. See LICENSE.

Authors