Skip to content

Commit

Permalink
chore: update makefile with comments
Browse files Browse the repository at this point in the history
  • Loading branch information
omerdemirok committed Dec 4, 2023
1 parent b9565d8 commit cf90991
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.PHONY: lint gofmt test run integration-test

gofmt:
gofmt: ## run gofmt
docker compose -f internal/build/docker-compose.yaml up gofmt

lint: gofmt
lint: gofmt ## run linter after gofmt
docker compose -f internal/build/docker-compose.yaml up lint

smoke-test: ## smoke tests
Expand All @@ -19,29 +19,29 @@ integration-test: ## run integration tests
@go test -v -count=1 -cover -race ./internal/integration-tests
$(MAKE) clean-workspaces

download-openapi-specs:
download-openapi-specs: ## download openapi specs
@echo "Downloading openapi specs"
@cd internal/docs && go run . && cd ../..

clean-workspaces: ## cleanup
@echo "Cleaning integration test workspaces"
CLEAN_UP_INTEGRATION_WORKSPACES=true go test -v -run Test_cleanupIntegrationWorkspaces ./...

check-license-header: ## Check if all *.py files have a license header
check-license-header: ## Check if all *.go files have a license header
curl -s https://raw.githubusercontent.com/lluissm/license-header-checker/master/install.sh | bash
./bin/license-header-checker -a -r .github/license-header.txt . go

help: ## Display help
@awk 'BEGIN {FS = ":.*##"; printf "Usage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
#------------- <https://suva.sh/posts/well-documented-makefiles> --------------
.PHONY: fern-login
.PHONY: fern-login ## login fern code generator
fern-login:
fern login

.PHONY: generate-core-code
.PHONY: generate-core-code ## generate code for the scope core
generate-core-code:
go run xata/internal/code-gen/code_gen.go -scope=core

.PHONY: generate-workspace-code
.PHONY: generate-workspace-code ## generate code for the scope workspace
generate-workspace-code:
go run xata/internal/code-gen/code_gen.go -scope=workspace

0 comments on commit cf90991

Please sign in to comment.