Merge branch '319-follow-up-readme' into 'master'

chore: describe components and Makefile targets (#319)

Closes #319

See merge request postgres-ai/database-lab!413

Author: NikolayS

CONTRIBUTING.md

@@ -68,7 +68,7 @@ Enhancement suggestions are tracked on [GitLab](https://gitlab.com/postgres-ai/d
 - Provide a step-by-step description of the proposed enhancement in as many details as possible.
 - Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples
 - Use Markdown to format code snippets and improve the overall look of your issues (Markdown docs: [GitLab](https://docs.gitlab.com/ee/user/markdown.html), [GitHub](https://github.github.com/gfm/)).
-- Describe the current behavior and explain which behavior you expected to see instead and why.
+- Describe the current behavior and explain which behavior you expected to see instead and why (on GitLab, you can use the issue template, which is selected by default).
 - If your proposal is related to UI, include screenshots and animated GIFs which help you demonstrate the steps or point out the part of DLE to which the suggestion is related. Please, do NOT use screenshots for console output, logs, configs.
 - Explain why this proposal would be helpful to most DLE users.
 - Specify which version of DLE you're using. If it makes sense, specify Postgres versions too.
@@ -126,10 +126,13 @@ We're building documentation following the principles described at https://docum
 
 Learn more: https://documentation.divio.com/.
 
-<!--
 ### Repo overview
-TBD
--->
+The [postgres-ai/database-lab](https://gitlab.com/postgres-ai/database-lab) repo contains 3 components:
+- [Database Lab Engine](https://gitlab.com/postgres-ai/database-lab/-/tree/master/cmd/database-lab)
+- [Database Lab CI Checker](https://gitlab.com/postgres-ai/database-lab/-/tree/master/cmd/runci)
+- [Database Lab CLI](https://gitlab.com/postgres-ai/database-lab/-/tree/master/cmd/cli)
+
+All three components have a single version, denoted by either the git tag or a combination of the branch name and git commit SHA.
 
 ### Development setup
 - Install Docker. Example for Linux:
@@ -173,10 +176,12 @@ TBD
 
 <!-- TODO: Linux specific requirements? MacOS specific? -->
 
-<!--
+
 ### Building from source
-TBD – separately for Linux and MacOS
+Use `Makefile` to build Database Lab components from source.
 
+Run `make help` to see all available targets.
 
+<!--
 mention dev images: See our [GitLab Container Registry](https://gitlab.com/postgres-ai/database-lab/container_registry) to find the images built for development branches.
--->
+-->

Makefile

@@ -18,54 +18,58 @@ LDFLAGS = -ldflags "-s -w \
 	-X gitlab.com/postgres-ai/database-lab/v3/version.buildTime=${BUILD_TIME}"
 
 # Go tooling command aliases
-GOBUILD = GO111MODULE=on GOARCH=${GOARCH} go build ${LDFLAGS}
-GOTEST = GO111MODULE=on go test -race 
-GORUN = GO111MODULE=on go run ${LDFLAGS}
+GOBUILD = GO111MODULE=on CGO_ENABLED=0 GOARCH=${GOARCH} go build ${LDFLAGS}
+GOTEST = GO111MODULE=on go test -race
 
 CLIENT_PLATFORMS=darwin linux freebsd windows
 ARCHITECTURES=amd64
 
-# Build the project
-all: clean build
+help: ## Display the help message
+	@echo "Please use \`make <target>\` where <target> is one of:"
+	@grep '^[a-zA-Z]' $(MAKEFILE_LIST) | \
+		awk -F ':.*?## ' 'NF==2 {printf "  %-22s%s\n", $$1, $$2}'
 
-# Install the linter to $GOPATH/bin which is expected to be in $PATH
-install-lint:
+all: clean build ## Build all binary components of the project
+
+install-lint: ## Install the linter to $GOPATH/bin which is expected to be in $PATH
 	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.42.1
 
-run-lint:
+run-lint: ## Run linters
 	golangci-lint run
 
-lint: install-lint run-lint
+lint: install-lint run-lint ## Install and run linters
 
-build:
+build: ## Build binary files of all Database Lab components (Engine, CI Checker, CLI)
 	${GOBUILD} -o bin/${SERVER_BINARY} ./cmd/database-lab/main.go
 	${GOBUILD} -o bin/${RUN_CI_BINARY} ./cmd/runci/main.go
 	${GOBUILD} -o bin/${CLI_BINARY} ./cmd/cli/main.go
 
-build-ci-checker:
+build-ci-checker: ## Build the Database Lab CI Checker binary
 	${GOBUILD} -o bin/${RUN_CI_BINARY} ./cmd/runci/main.go
 
-build-client:
+build-client: ## Build Database Lab CLI binaries for all supported operating systems and platforms
 	$(foreach GOOS, $(CLIENT_PLATFORMS),\
 		$(foreach GOARCH, $(ARCHITECTURES), \
 		$(shell \
 			export GOOS=$(GOOS); \
 			export GOARCH=$(GOARCH); \
 			${GOBUILD} -o bin/cli/$(CLI_BINARY)-$(GOOS)-$(GOARCH) ./cmd/cli/main.go)))
 
-test:
+build-image: ## Build Docker image with the locally compiled DLE binary
+	docker build -t dblab_server:local  -f Dockerfile.dblab-server .
+
+build-dle: build build-image ## Build Database Lab Engine binary and Docker image
+
+test: ## Run unit tests
 	${GOTEST} ./...
 
-test-ci-integration:
+test-ci-integration: ## Run integration tests
 	GO111MODULE=on go test -race  -tags=integration ./...
 
-fmt:
+fmt: ## Format code
 	go fmt $$(go list ./... | grep -v /vendor/)
 
-clean:
+clean: ## Remove compiled binaries from the local bin/ directory
 	rm -f bin/*
 
-run:
-	${GORUN} ./cmd/database-lab/*
-
-.PHONY: all build test run-lint install-lint lint fmt clean run
+.PHONY: help all build test run-lint install-lint lint fmt clean build-image build-dle build-ci-checker build-client build-ci-checker