Buildtime Trend dashboard
JavaScript HTML CSS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
.gitignore
.scrutinizer.yml
COPYING
ChangeLog
LICENSE
README.md
config_sample.js
index.html
projects.html
stats.html

README.md

Buildtime Trend dashboard

Visualise what's trending in your build process

Buildtime Trend dashboard Buildtime Trend dashboard (dev) Codacy Badge Scrutinizer Code Quality

Description

Dashboard with charts and trends of build data gathered by Python Client or Buildtime Trend as a Service. This dashboard is part of Buildtime Trend as a Service, it is deployed by the Python Client, or it can be used stand alone.

Available charts and metrics

  • number of builds, successful and failed
  • average build duration
  • chart with duration of individual build stages
  • chart with builds per branch
  • charts with build duration per time of day/day of week

You can see it in action!

How to get it?

The latest version is available for download as zip and tarball on GitHub. Unzip and copy to the desired directory.

If you prefer to use git, several options are available :

  • development version : git clone https://github.com/buildtimetrend/dashboard.git
  • latest release : git clone https://github.com/buildtimetrend/dashboard.git --branch release
  • a specific release : git clone https://github.com/buildtimetrend/dashboard.git --branch v0.3

Usage

The dashboard is hosted on Buildtime Trend as a Service. When you setup the Python Client as part of your build process, it will deploy the dashboard to the github pages of your project.

To install a standalone version :

  • download the project and copy the project to a folder on your website, see How to get it?
  • copy config_sample.js to config.js and adjust it to your needs :
 keenConfig = {
    projectId: "keen_project_id", // required
    readKey: "keen_read_key" // required
};

var config = {
    projectName: "project_name", // descriptive project name (used in the title), optional
    repoName: "repo_name", // repo name, fe. "buildtimetrend/python-client"
    serviceUrl: "service_url", // url to Buildtime Trend as a Service, fe. https://buildtimetrend-dev.herokuapp.com/, optional
    websiteUrl: "website_url", // url to project website, optional
    projectList: [] // list of repoNames of other projects hosted on the same website, optional
};

Url parameters

  • refresh : leave empty, or set to '0' to disable auto refreshing the charts. If url parameter refresh is defined and set to a positive integer value, auto refreshing the charts is enabled. refresh is defined in minutes, so a value of 10 will refresh the charts every 10 minutes. The refresh rate should at least be equal to maximum age of the Query cache, if it is less, the cache max age value will be used (typically, 10 min).
  • timeframe : the default timeframe can be set with this url parameter. Possible values : day, week, month, year. If it is not defined the default timeframe is used (week)
  • filter_* : set the default filter value. When this url parameter is defined, the corresponding filter dropdown will be set to this value and it will be applied to the queries of all charts and metrics. Available filters :
    • filter_build_matrix : Build matrix environment settings, usually a combination of language, language version and operating system : fe. python 2.7 linux
    • filter_build_result : Build job result, possible values : passed, errored, failed, ...
    • filter_build_trigger : What triggered the build job, possible values : pull_request, push (git push)
    • filter_branch : Repository branch that was build : fe. master

Bugs and feature requests

Please report bugs and add feature requests in the Github issue tracker.

Contribute

If you want to contribute to make Buildtime Trend even better, check out the contribution page. We are looking for testers, developers, designers, ... and what more. Contact us if you want to help out.

Donations

You can support the project by making a donation. The donations will help pay for the hosting and support further development.

Credits

For an overview of who contributed to create Buildtime trend, see Credits.

Contact

Project website : https://buildtimetrend.github.io/

Mailinglist : Buildtime Trend Community

Follow us on Twitter, Github and OpenHub.

License

Copyright (C) 2014-2016 Dieter Adriaenssens ruleant@users.sourceforge.net

This software was originally released under GNU General Public License version 3 or any later version, all commits contributed from 12th of November 2014 on, are contributed as GNU Affero General Public License. Hence the project is considered to be GNU Affero General Public License from 12th of November 2014 on.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.