build-window
build-window copied to clipboard
Information radiator for the health of your CI builds
Build Window
Dashboard built using Smashing (formerly Dashing). Currently supports Jenkins, Travis, TeamCity, Bamboo and Go.
Example
Getting started
Get the code. It's probably best to fork this repo so you can keep your config in source code, otherwise you can just clone it:
git clone [email protected]:rouanw/build-window.git && cd build-window
Run bundle install
.
Edit config/builds.json
with the configuration for your builds:
{
"bambooBaseUrl": "https://ci.openmrs.org",
"teamCityBaseUrl": "https://teamcity.jetbrains.com",
"goBaseUrl":"https://build.go.cd",
"jenkinsBaseUrl": "https://builds.apache.org",
"builds": [
{"id": "sinatra/sinatra", "server": "Travis"},
{"id": "IntelliJIdeaCe_CommunityTestsLinuxJava8", "server": "TeamCity"},
{"id": "Lucene-Solr-Maven-master", "server": "Jenkins"},
{"id": "BB-BDB", "server": "Bamboo"},
{"id": "build-linux", "server": "Go"}
]
}
Run smashing start
.
Runs at http://localhost:3030/builds
by default.
Run smashing start -d -p 3031
to run it as a daemon and to specify the port. You can stop the daemon with smashing stop
.
See https://github.com/Smashing/smashing/wiki for more details.
Authentication
Place your API credentials in a .env
file at the root of the project. (Please note that authentication is currently only supported for Go CD, Jenkins and TeamCity.) Example:
Go
GO_USER=view
GO_PASSWORD=password
Jenkins
JENKINS_USER=user
JENKINS_TOKEN=password
TeamCity
TEAM_CITY_USER=user
TEAM_CITY_PASSWORD=password
Different Base URLs
If you have multiple build servers of the same type you'd like to keep an eye on you can specify the baseUrl
for each build:
{
"builds": [
{"id": "Lucene-Solr-Maven-master", "server": "Jenkins", "baseUrl": "https://builds.apache.org"}
]
}
Please note that this is currently only supported for Jenkins, Go and Bamboo.
Docker support
You can spin up a Docker container with build-window by running:
docker-compose up -d
The application will be ready at http://localhost:3030
(Linux) or at http://<DOCKER_HOST_IP>:3030
(Windows/OS X).
You can also build the image and run a container separately, but Docker Compose makes this process much simpler.
Contributing
Pull requests welcome. Run the tests with rspec
.
Contributions
Thanks to Max Lincoln (@maxlinc) for coming up with the name Build Window.