Makefile

#! /usr/bin/make
#
# Makefile for Goa v3
#
# Targets:
# - "depend" retrieves the Go packages needed to run the linter and tests
# - "lint" runs the linter
# - "test" runs the tests
# - "release" creates a new release commit, tags the commit and pushes the tag to GitHub.
#   "release" also updates the examples and plugins repo and pushes the updates to GitHub.
# - "prepare-preview" creates the version commit for an opt-in Goa preview.
# - "release-preview" tags and publishes that preview without changing other repositories.
#
# Meta targets:
# - "all" is the default target, it runs "lint" and "test"
#
MAJOR=3
MINOR=32
BUILD=0
PREVIEW_NUMBER?=

PREVIEW_TAG=v$(MAJOR).$(MINOR).$(BUILD)-preview.$(PREVIEW_NUMBER)

GOOS=$(shell go env GOOS)
GOARCH=$(shell go env GOARCH)
GO_FILES=$(shell find . -type f -name '*.go')
GOPATH=$(shell go env GOPATH)
GOBIN_DIR=$(GOPATH)/bin
GOLANGCI_LINT_VERSION?=v2.13.2
GOLANGCI_LINT=$(GOBIN_DIR)/golangci-lint
PROTOC_BIN=protoc
PROTOC_DEST=$(GOBIN_DIR)/$(PROTOC_BIN)
PROTOC_INCLUDE_DEST=$(GOPATH)/include

.PHONY: all all-tests ci depend lint test test-release integration-test build-goa
.PHONY: release stable-release-check release-preflight release-goa release-examples release-plugins
.PHONY: preview-version preview-check preview-preflight prepare-preview release-preview
.NOTPARALLEL: release release-goa release-examples release-plugins prepare-preview release-preview

# Only list test and build dependencies
# Standard dependencies are installed via go get
DEPEND=\
	google.golang.org/protobuf/cmd/protoc-gen-go@v1.36.12 \
	google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.6.2

all: lint test integration-test

all-tests: lint test integration-test

ci: depend all

# Install protoc
PROTOC_VERSION=25.0
UNZIP=unzip
ifeq ($(GOOS),linux)
	PROTOC=protoc-$(PROTOC_VERSION)-linux-x86_64
	PROTOC_EXEC=$(PROTOC)/bin/protoc
endif
ifeq ($(GOOS),darwin)
	ifeq ($(GOARCH),arm64)
		PROTOC=protoc-$(PROTOC_VERSION)-osx-aarch_64
		PROTOC_EXEC=$(PROTOC)/bin/protoc
	else
		PROTOC=protoc-$(PROTOC_VERSION)-osx-x86_64
		PROTOC_EXEC=$(PROTOC)/bin/protoc
	endif
endif
ifeq ($(GOOS),windows)
	PROTOC=protoc-$(PROTOC_VERSION)-win32
	PROTOC_EXEC="$(PROTOC)\bin\protoc.exe"
	PROTOC_BIN=protoc.exe
	GOPATH:=$(subst \,/,$(GOPATH))
endif

depend:
	@echo INSTALLING DEPENDENCIES...
	@mkdir -p "$(GOBIN_DIR)"
	@go mod download
	@for package in $(DEPEND); do GOBIN="$(GOBIN_DIR)" go install $$package; done
	@curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/$(GOLANGCI_LINT_VERSION)/install.sh | sh -s -- -b $(GOBIN_DIR) $(GOLANGCI_LINT_VERSION)
	@$(GOLANGCI_LINT) version
	@go mod tidy -compat=1.17
	@echo INSTALLING PROTOC...
	@rm -rf "$(PROTOC)"
	@mkdir -p "$(PROTOC)"
	@cd $(PROTOC); \
	curl -O -L https://github.com/protocolbuffers/protobuf/releases/download/v$(PROTOC_VERSION)/$(PROTOC).zip; \
	$(UNZIP) $(PROTOC).zip
	@rm -f "$(PROTOC_DEST)" && \
		cp $(PROTOC_EXEC) "$(PROTOC_DEST)" && \
		mkdir -p "$(PROTOC_INCLUDE_DEST)" && \
		cp -R "$(PROTOC)/include/." "$(PROTOC_INCLUDE_DEST)" && \
		chmod 0755 "$(PROTOC_DEST)" && \
		rm -rf $(PROTOC) && \
		"$(PROTOC_DEST)" --version

lint:
ifneq ($(GOOS),windows)
	@$(GOLANGCI_LINT) run ./... || (echo "^ - lint errors!" && echo && exit 1)
endif

test:
ifneq ($(GOOS),windows)
	PATH="$(GOBIN_DIR):$$PATH" go test ./... --coverprofile=cover.out
else
	go test ./... --coverprofile=cover.out
endif

test-release:
ifneq ($(GOOS),windows)
	PATH="$(GOBIN_DIR):$$PATH" go test -count=1 ./...
else
	go test -count=1 ./...
endif

integration-test: build-goa
ifneq ($(GOOS),windows)
	cd jsonrpc/integration_tests && PATH="$(GOBIN_DIR):$$PATH" go test -count=1 -timeout 10m ./...
endif

# Needed for CI to run integration tests
build-goa:
	cd cmd/goa && GOBIN="$(GOBIN_DIR)" go install .

release-preflight: lint test-release integration-test

stable-release-check:
	@if [ "$(MAJOR)" != "3" ]; then \
		echo "error: Goa releases must use major version 3"; \
		exit 1; \
	fi
	@if [ -n "$(PREVIEW_NUMBER)" ]; then \
		echo "error: PREVIEW_NUMBER is set; use the preview release targets"; \
		exit 1; \
	fi

release: stable-release-check release-goa release-examples release-plugins
	@echo "Release v$(MAJOR).$(MINOR).$(BUILD) complete"

preview-version:
	@if [ "$(MAJOR)" != "3" ]; then \
		echo "error: Goa preview releases must use major version 3"; \
		exit 1; \
	fi
	@case "$(MINOR)" in \
		""|*[!0-9]*|0[0-9]*) \
			echo "error: MINOR must be a non-negative integer without a leading zero"; \
			exit 1; \
			;; \
	esac
	@case "$(BUILD)" in \
		""|*[!0-9]*|0[0-9]*) \
			echo "error: BUILD must be a non-negative integer without a leading zero"; \
			exit 1; \
			;; \
	esac
	@case "$(PREVIEW_NUMBER)" in \
		""|*[!0-9]*) \
			echo "error: PREVIEW_NUMBER must be a positive integer"; \
			exit 1; \
			;; \
		0|0*) \
			echo "error: PREVIEW_NUMBER must not be zero or start with zero"; \
			exit 1; \
			;; \
	esac
	@echo "$(PREVIEW_TAG)"

preview-check: preview-version
	@status="$$(git status --porcelain)"; \
	if [ -n "$$status" ]; then \
		echo "error: goa repo has uncommitted changes:"; \
		echo "$$status"; \
		exit 1; \
	fi
	@if git rev-parse --verify --quiet "refs/tags/$(PREVIEW_TAG)" >/dev/null; then \
		echo "error: local tag $(PREVIEW_TAG) already exists"; \
		exit 1; \
	fi
	@if git ls-remote --exit-code --tags origin "refs/tags/$(PREVIEW_TAG)" >/dev/null 2>&1; then \
		echo "error: remote tag $(PREVIEW_TAG) already exists"; \
		exit 1; \
	fi

preview-preflight: preview-check release-preflight

prepare-preview: preview-preflight
	sed 's/^MINOR=.*/MINOR=$(MINOR)/' Makefile > _tmp && mv _tmp Makefile
	sed 's/^BUILD=.*/BUILD=$(BUILD)/' Makefile > _tmp && mv _tmp Makefile
	sed 's/^PREVIEW_NUMBER?=.*/PREVIEW_NUMBER?=$(PREVIEW_NUMBER)/' Makefile > _tmp && mv _tmp Makefile
	sed 's/Minor = .*/Minor = $(MINOR)/' pkg/version.go > _tmp && mv _tmp pkg/version.go
	sed 's/Build = .*/Build = $(BUILD)/' pkg/version.go > _tmp && mv _tmp pkg/version.go
	sed 's/Suffix = .*/Suffix = "preview.$(PREVIEW_NUMBER)"/' pkg/version.go > _tmp && mv _tmp pkg/version.go
	@test "$$(go run ./cmd/goa version)" = "Goa version $(PREVIEW_TAG)"
	git add Makefile pkg/version.go
	git commit -m "Prepare $(PREVIEW_TAG)"

release-preview: preview-preflight
	@expected="Goa version $(PREVIEW_TAG)"; \
	actual="$$(go run ./cmd/goa version)"; \
	if [ "$$actual" != "$$expected" ]; then \
		echo "error: generated version is $$actual, expected $$expected"; \
		exit 1; \
	fi
	@branch="$$(git branch --show-current)"; \
	if [ -z "$$branch" ]; then \
		echo "error: preview release must run from a branch"; \
		exit 1; \
	fi; \
	remote_head="$$(git ls-remote origin "refs/heads/$$branch" | awk '{print $$1}')"; \
	local_head="$$(git rev-parse HEAD)"; \
	if [ "$$remote_head" != "$$local_head" ]; then \
		echo "error: push branch $$branch and wait for its checks before publishing $(PREVIEW_TAG)"; \
		exit 1; \
	fi
	git tag $(PREVIEW_TAG)
	git push origin $(PREVIEW_TAG)
	@echo "Preview $(PREVIEW_TAG) published; examples and plugins were not changed"

release-goa:
	# First make sure all is clean
	@test "$$(git branch --show-current)" = "v$(MAJOR)"
	@status="$$(git status --porcelain)"; \
	if [ -n "$$status" ]; then \
		echo "error: goa repo has uncommitted changes:"; \
		echo "$$status"; \
		exit 1; \
	fi
	cd $(GOPATH)/src/goa.design/examples && \
		test "$$(git branch --show-current)" = main && \
		status="$$(git status --porcelain)" && \
		if [ -n "$$status" ]; then \
			echo "error: examples repo has uncommitted changes:"; \
			echo "$$status"; \
			exit 1; \
		fi && \
		git pull --ff-only origin main
	cd $(GOPATH)/src/goa.design/plugins && \
		test "$$(git branch --show-current)" = "v$(MAJOR)" && \
		status="$$(git status --porcelain)" && \
		if [ -n "$$status" ]; then \
			echo "error: plugins repo has uncommitted changes:"; \
			echo "$$status"; \
			exit 1; \
		fi && \
		git pull --ff-only origin v$(MAJOR)
	go mod tidy 
	# Bump version number, commit and push
	sed 's/Major = .*/Major = $(MAJOR)/' pkg/version.go > _tmp && mv _tmp pkg/version.go
	sed 's/Minor = .*/Minor = $(MINOR)/' pkg/version.go > _tmp && mv _tmp pkg/version.go
	sed 's/Build = .*/Build = $(BUILD)/' pkg/version.go > _tmp && mv _tmp pkg/version.go
	sed 's/Suffix = .*/Suffix = ""/' pkg/version.go > _tmp && mv _tmp pkg/version.go
	sed 's/goa\/v3@v.*tab=doc/goa\/v3@v$(MAJOR).$(MINOR).$(BUILD)\/dsl?tab=doc/' README.md > _tmp && mv _tmp README.md
	$(MAKE) release-preflight
	git add .
	git commit -m "Release v$(MAJOR).$(MINOR).$(BUILD)"
	git tag v$(MAJOR).$(MINOR).$(BUILD)
	cd cmd/goa && go install .
	git push origin v$(MAJOR)
	git push origin v$(MAJOR).$(MINOR).$(BUILD)
	# Wait for Go proxy to update
	sleep 10

release-examples:
	cd $(GOPATH)/src/goa.design/examples && \
		make GOA_VERSION=v$(MAJOR).$(MINOR).$(BUILD)&& \
		git add . && \
		git commit -m "Release v$(MAJOR).$(MINOR).$(BUILD)" && \
		git tag v$(MAJOR).$(MINOR).$(BUILD) && \
		git push origin main && \
		git push origin v$(MAJOR).$(MINOR).$(BUILD)

release-plugins:
	cd $(GOPATH)/src/goa.design/plugins && \
		for module in $$(find . -name go.mod -not -path './.git/*'); do \
			(cd "$$(dirname "$$module")" && \
				go mod edit -require=goa.design/goa/v$(MAJOR)@v$(MAJOR).$(MINOR).$(BUILD) && \
				go mod tidy) || exit 1; \
		done && \
		make && \
		git add . && \
		git commit -m "Release v$(MAJOR).$(MINOR).$(BUILD)" && \
		git tag v$(MAJOR).$(MINOR).$(BUILD) && \
		git push origin v$(MAJOR) && \
		git push origin v$(MAJOR).$(MINOR).$(BUILD)