Go
dev
Makefile
# Change these variables as necessary.
MAIN_PACKAGE_PATH := ./cmd/
BINARY_NAME := weavc
# ==================================================================================== #
# HELPERS
# ==================================================================================== #
## help: print this help message. Picks out "## <name>: <description>".
.PHONY: help
help:
@echo 'Usage:'
@sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ':' | sed -e 's/^/ /'
.PHONY: confirm
confirm:
@echo -n 'Are you sure? [y/N] ' && read ans && [ $${ans:-N} = y ]
.PHONY: no-dirty
no-dirty:
git diff --exit-code
# ==================================================================================== #
# QUALITY CONTROL
# ==================================================================================== #
## tidy: format code and tidy modfile
.PHONY: tidy
tidy:
go fmt ./...
go mod tidy -v
## audit: run quality control checks
.PHONY: audit
audit:
go mod verify
go vet ./...
go run honnef.co/go/tools/cmd/staticcheck@latest -checks=all,-ST1000,-U1000 ./...
go run golang.org/x/vuln/cmd/govulncheck@latest ./...
go test -race -buildvcs -vet=off ./...
# ==================================================================================== #
# DEVELOPMENT
# ==================================================================================== #
## test: run all tests
.PHONY: test
test:
go test -v -race -buildvcs ./...
## test/cover: run all tests and display coverage
.PHONY: test/cover
test/cover:
go test -v -race -buildvcs -coverprofile=/tmp/coverage.out ./...
go tool cover -html=/tmp/coverage.out
## build: build the application
.PHONY: build
build: build/generate
go build -o=/tmp/bin/${BINARY_NAME} ${MAIN_PACKAGE_PATH}
## build: build the application
.PHONY: build/serve
build/serve: build/generate
go build -o=/tmp/bin/${BINARY_NAME}_serve ${MAIN_PACKAGE_PATH}serve
## build: build the application
.PHONY: build/discord
build/discord: build/generate
go build -o=/tmp/bin/${BINARY_NAME}_discord ${MAIN_PACKAGE_PATH}discord
.PHONY: build/generate
build/generate:
templ generate
protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative proto/*.proto
## run: run the application
.PHONY: run
run: build
/tmp/bin/${BINARY_NAME}
## run/live: run the application with reloading on file changes
.PHONY: run/live
run/live:
go run github.com/cosmtrek/air@v1.43.0 \
--build.cmd "make build" --build.bin "/tmp/bin/${BINARY_NAME}" --build.delay "1000" \
--build.exclude_dir "" \
--build.exclude_regex "(.*_templ.go)|(.*.pb.go)" \
--build.include_ext "go, templ, tpl, tmpl, html, css, scss, js, ts, sql, jpeg, jpg, gif, png, bmp, svg, webp, ico, proto" \
--misc.clean_on_exit "true"
# ==================================================================================== #
# OPERATIONS
# ==================================================================================== #
## push: push changes to the remote Git repository
.PHONY: push
push: tidy audit no-dirty
git push
## production/deploy: deploy the application to production
.PHONY: production/deploy
production/deploy: confirm tidy audit no-dirty
GOOS=linux GOARCH=amd64 go build -ldflags='-s' -o=/tmp/bin/linux_amd64/${BINARY_NAME} ${MAIN_PACKAGE_PATH}
upx -5 /tmp/bin/linux_amd64/${BINARY_NAME}
# Include additional deployment steps here...
.PHONY: production/docker
production/docker: tidy
docker build -f .docker/Dockerfile -t ${BINARY_NAME}:latest .