2020-04-06 16:40:40 +02:00
|
|
|
# Docker API
|
|
|
|
|
|
2020-05-03 15:31:05 +02:00
|
|
|
[](https://github.com/docker/api/actions)
|
2020-05-03 15:25:50 +02:00
|
|
|
|
2020-04-06 16:40:40 +02:00
|
|
|
## Dev Setup
|
|
|
|
|
|
2020-05-04 23:50:00 +02:00
|
|
|
The recommended way is to use the main `Makefile` that runs everything inside a container.
|
|
|
|
|
|
|
|
|
|
If you don't have or want to use Docker for building you need to make sure you have all the needed tools installed locally:
|
|
|
|
|
|
|
|
|
|
* go 1.14
|
2020-05-14 21:48:50 +02:00
|
|
|
* [protoc](https://github.com/protocolbuffers/protobuf)
|
2020-05-04 23:50:00 +02:00
|
|
|
* `go get github.com/golang/protobuf/protoc-gen-go@v1.4.1`
|
|
|
|
|
* `go get golang.org/x/tools/cmd/goimports`
|
|
|
|
|
* `go get github.com/golangci/golangci-lint/cmd/golangci-lint@v1.26.0`
|
|
|
|
|
|
|
|
|
|
And then you can call the same make targets but you need to pass it the `builder.Makefile` (`make -f builder.Makefile`).
|
2020-04-06 16:43:36 +02:00
|
|
|
|
2020-05-04 22:31:59 +02:00
|
|
|
## Building the project
|
2020-04-06 16:43:36 +02:00
|
|
|
|
|
|
|
|
```bash
|
2020-05-04 22:31:59 +02:00
|
|
|
$ make
|
2020-04-06 16:43:36 +02:00
|
|
|
```
|
2020-05-04 22:31:59 +02:00
|
|
|
|
|
|
|
|
If you make changes to the `.proto` files, make sure to `make protos` to generate go code.
|
2020-05-06 09:37:52 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Tests
|
|
|
|
|
|
|
|
|
|
To run unit tests:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
make test
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
If you need to update a golden file simply do `go test ./... -test.update-golden`.
|
