Makefile

# ╭────────────────────----------------──────────╮
# │                    commit                    │
# ╰─────────────────────----------------─────────╯

.PHONY: help test test-e2e test-all
help: Makefile
	@sed -n 's/^##//p' $< | awk 'BEGIN {FS = "|"}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

## setup | install dependencies
setup:
	@go mod tidy -e && go mod download
	@go install go.uber.org/mock/mockgen@latest
	@go install github.com/onsi/ginkgo/v2
	@go install github.com/onsi/gomega

## setup-release | install tools for release process
setup-release:
	@go install github.com/goreleaser/goreleaser/v2@latest
	@go install github.com/anchore/syft/cmd/syft@latest
	@go install github.com/sigstore/cosign/v2/cmd/cosign@latest

# ╭────────────────────----------------──────────╮
# │               General workflow               │
# ╰─────────────────────----------------─────────╯

## test | run unit and end-to-end tests
test: test-unit test-e2e

## test | run unit tests
# -count=1 is needed to prevent caching of test results.
test-unit:
	@go test -count=1 -v -race $(shell go list ./... | grep -Ev '/(tests|e2e)($$|/)')

## test-e2e | run black-box end-to-end tests
test-e2e:
	@go run github.com/onsi/ginkgo/v2/ginkgo \
		--race \
		--procs=4 \
		--randomize-all \
		--fail-on-pending \
		--fail-on-empty \
		--trace \
		--timeout=5m \
		./e2e

## build | build development version of binary
build:
	@go build -gcflags="all=-N -l" -race -v -o ./build/commit .
	@file -h ./build/commit && du -h ./build/commit && sha256sum ./build/commit && go tool buildid ./build/commit

## generate | generate code for all modules
# Side effects of this command should to be commited.
generate:
	@go mod tidy -e
	@go generate ./...

# ╭────────────────────----------------──────────╮
# │                   Release                    │
# ╰─────────────────────----------------─────────╯

## release-check | validate goreleaser configuration
release-check:
	@goreleaser --config .goreleaser.yaml check

## release-snapshot | build release artifacts without publishing
release-snapshot:
	@goreleaser --config .goreleaser.yaml release --snapshot --clean --skip=publish,sign

## release-local | test the full release process locally
release-local:
	@goreleaser --config .goreleaser.yaml release --skip=publish --clean