tyler.durden
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
compose/README.md

37 lines
999 B
Markdown
Raw Normal View History

Initial commit of makefile and setup scripts Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2020-04-06 16:40:40 +02:00
# Docker API
Fix badge...
2020-05-03 15:31:05 +02:00
[![Actions Status](https://github.com/docker/api/workflows/Continuous%20integration/badge.svg)](https://github.com/docker/api/actions)
Add ci badge in the readme
2020-05-03 15:25:50 +02:00
Initial commit of makefile and setup scripts Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2020-04-06 16:40:40 +02:00
## Dev Setup
Add `make lint` and run it on CI
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
* `go get github.com/golang/protobuf/protoc-gen-go@v1.4.1`
* `go get golang.org/x/tools/cmd/goimports`
* `go get gotest.tools/gotestsum@v0.4.2`
* `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`).
Add doc.go The doc.go file in the proto package allows protobuild to find all protobuf packages in the project and compile the protos. Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2020-04-06 16:43:36 +02:00
Cleanup Makefiles * add `make help` target * remove unused variables * add .exe to the binary name when on windows * add ldflags to go build to strip the binary (smaller binary size) * `make protos` must be executed manually when proto files change
2020-05-04 22:31:59 +02:00
## Building the project
Add doc.go The doc.go file in the proto package allows protobuild to find all protobuf packages in the project and compile the protos. Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2020-04-06 16:43:36 +02:00
```bash
Cleanup Makefiles * add `make help` target * remove unused variables * add .exe to the binary name when on windows * add ldflags to go build to strip the binary (smaller binary size) * `make protos` must be executed manually when proto files change
2020-05-04 22:31:59 +02:00
$ make
Add doc.go The doc.go file in the proto package allows protobuild to find all protobuf packages in the project and compile the protos. Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2020-04-06 16:43:36 +02:00
```
Cleanup Makefiles * add `make help` target * remove unused variables * add .exe to the binary name when on windows * add ldflags to go build to strip the binary (smaller binary size) * `make protos` must be executed manually when proto files change
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.
Implement quiet flag for ps command
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`.