Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cburgmer/buildviz
Transparency for your build pipeline's results and runtime
https://github.com/cburgmer/buildviz
cd ci concourse continuous-delivery continuous-integration gocd jenkins pipeline teamcity
Last synced: 3 months ago
JSON representation
Transparency for your build pipeline's results and runtime
- Host: GitHub
- URL: https://github.com/cburgmer/buildviz
- Owner: cburgmer
- License: bsd-2-clause
- Created: 2015-05-10T04:27:30.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T13:50:07.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T19:39:28.323Z (6 months ago)
- Topics: cd, ci, concourse, continuous-delivery, continuous-integration, gocd, jenkins, pipeline, teamcity
- Language: Clojure
- Homepage: https://buildviz.cburgmer.space/
- Size: 4.47 MB
- Stars: 109
- Watchers: 4
- Forks: 9
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# buildviz
Transparency for your build pipeline's results and runtime.
> The most important things cannot be measured.
> - [W. Edwards Deming](https://en.wikipedia.org/wiki/W._Edwards_Deming)
>
> > Your build pipeline can.
> > - Anonymous
## The What
Buildviz provides graphs detailing runtime behaviour, failures and stability of
the pipeline, answering a [multitude of questions](https://github.com/cburgmer/buildviz/wiki/Questions)
in the hopes of improving your pipeline.
All it needs is your build history including test results.
Live example: https://buildviz.cburgmer.space/
## Usage
$ curl -OL https://github.com/cburgmer/buildviz/releases/download/0.15.1/buildviz-0.15.1-standalone.jar
$ java -jar buildviz-0.15.1-standalone.jar
Now, buildviz takes in build data via `POST` to `/builds`. Some suggestions how
to set it up:
#### Sync from supported build servers
Buildviz understands build data extracted by [build-facts](https://github.com/cburgmer/build-facts).
Currently the following CI/CD systems are [supported](https://github.com/cburgmer/build-facts#supported-build-servers):
- Concourse
- GoCD
- Jenkins
- TeamCity
Example:
# After starting up Buildviz locally, do:
$ curl -LO https://github.com/cburgmer/build-facts/releases/download/0.5.4/build-facts-0.5.4-standalone.jar
$ java -jar build-facts-0.5.4-standalone.jar jenkins http://localhost:8080 --state state.json \
| curl -v -H "Content-type: text/plain" -d@- 'http://localhost:3000/builds'
#### DIY
You can also roll your own. For every build `POST` JSON data to `http://localhost:3000/builds/`,
for example:
```js
{
"jobName": "my job",
"buildId": "42"
"start": 1451449853542,
"end": 1451449870555,
"outcome": "pass",
"inputs": [{
"revision": "1eadcdd4d35f9a",
"sourceId": "[email protected]:cburgmer/buildviz.git"
}],
"triggeredBy": [{
"jobName": "Test",
"buildId": "42"
}],
"testResults": [{
"name": "Test Suite",
"children": [{
"classname": "some.class",
"name": "A Test",
"runtime": 2,
"status": "pass"
}]
}]
}
```
The build's `jobName`, `buildId`, and `start` are required, all other values are
optional. Buildviz follows [this JSON schema](./resources/schema.json).
JUnit XML ([or JSON](https://github.com/cburgmer/buildviz/wiki#help-my-tests-dont-generate-junit-xml))
formatted test results can be `PUT` to `http://localhost:3000/builds/$JOB_NAME/$BUILD_ID/testresults`
## More
[FAQ](https://github.com/cburgmer/buildviz/wiki)
You might also like:
* [Polaris](https://sites.google.com/thoughtworks.com/polaris/home), automated tracking of engineering excellence fitness metrics.
* [Metrik](https://github.com/thoughtworks/metrik), calculates the [four key metrics](https://www.thoughtworks.com/radar/techniques/four-key-metrics) based on CI/CD build data.
* [Four Keys](https://github.com/GoogleCloudPlatform/fourkeys), measures the four key metrics.
* [HeartBeat](https://github.com/thoughtworks/HeartBeat), calculates delivery metrics from CI/CD build data, revision control and project planning tools.
* [Kuona project for IT Analytics](https://github.com/kuona/kuona-project), provides a dashboard on data from various sources.
* [Test Trend Analyzer](https://github.com/anandbagmar/tta), consumes test results for test trends.
* [TRT](https://github.com/thetestpeople/trt), consumes test results for test trends.
* [GoCD's analytics extension](https://extensions-docs.gocd.org/analytics/current/), collects and displays build metrics for GoCD.
* [pulse](https://www.pulse.codacy.com), support the continuous improvement of your engineering teams with data-driven insights.
* [Jellyfish](https://jellyfish.co), translate and maximize the business impact of engineering.
* [BuildPulse](https://github.com/marketplace/buildpulse), automatically detects flaky tests.
Reach out to [@cburgmer](https://twitter.com/cburgmer) for feedback and ideas.