Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cburgmer committed Sep 12, 2015
1 parent ced9dc7 commit 45a5ee0
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 10 deletions.
20 changes: 20 additions & 0 deletions DEVELOP
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Just a few pointers if you want to make changes to buildviz:

## Run the server locally

$ ./lein do deps, ring server

## Run gosync locally

$ ./lein run -m buildviz.gosync http://$USER:$PW@localhost:8153/go

## Run the tests

$ ./lein test

## Run gosync against mock for testing

$ cd test/gosync
$ ./mock.sh
# In a 2nd session
$ ./lein run -m buildviz.gosync http://localhost:8080 --from 2014-01-01
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,14 @@ or run Go.cd in a Vagrant box and sync its job history with buildviz

## Usage

$ ./lein do deps, ring server
$ curl -OL https://github.com/cburgmer/buildviz/releases/download/0.3.0/buildviz-0.3.0-standalone.jar
$ java -jar buildviz-0.3.0-standalone.jar

Then `PUT` JSON data in the following format to `http://localhost:3000/builds/$JOB_NAME/$BUILD_ID`
Now, buildviz takes in new build results via `PUT` to `/builds`. Some suggestions how to do the setup:

#### DIY

For every build `PUT` JSON data in the following format to `http://localhost:3000/builds/$JOB_NAME/$BUILD_ID`

```js
{
Expand All @@ -44,17 +49,13 @@ You can omit any of the above values, however some of the statistics will not be

JUnit XML formatted test results can be `PUT` to `http://localhost:3000/builds/$JOB_NAME/$BUILD_ID/testresults`

## Getting the data
#### Sync from [Go.cd](http://www.go.cd)

Buildviz does not care where the data is coming from. The idea is for you to PUT new outcomes to `/builds` whenever another build has run.
Sync existing history (see `--help` for details):

If you are using [Go.cd](http://www.go.cd), you might like the shipped script to sync existing history:

```sh
./lein run -m buildviz.gosync http://$USER:$PW@localhost:8153/go
```
$ java -cp buildviz-0.3.0-standalone.jar buildviz.gosync http://$USER:$PW@localhost:8153/go

### More
## More

[FAQ](https://github.com/cburgmer/buildviz/wiki)

Expand Down

0 comments on commit 45a5ee0

Please sign in to comment.