Makefile

#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

VERSION_PATH=main
-include .env
VERSION ?= $(if $(RELEASE_VERSION),$(RELEASE_VERSION),dev-$(shell git rev-parse --short HEAD 2>/dev/null || echo unknown))
GIT_COMMIT ?= $(shell git rev-parse HEAD 2>/dev/null || echo unknown)
BUILD_DATE=$(shell date -u +"%Y-%m-%dT%H:%M:%SZ")
MKDIR_P = mkdir -p

GO_LINT = golangci-lint
LICENSE_EYE = license-eye

HUB ?= ghcr.io/apache
APP_NAME = skywalking-mcp
IMAGE ?= $(HUB)/$(APP_NAME)
PLATFORMS ?= linux/amd64
MULTI_PLATFORMS ?= linux/amd64,linux/arm64
OUTPUT ?= --load
IMAGE_TAGS ?= -t $(IMAGE):$(VERSION) -t $(IMAGE):latest
GO_TEST_FLAGS ?=
GO_TEST_PKGS ?= ./...

.PHONY: all
all: build ;

.PHONY: help
help: ## Show this help message.
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "  %-25s %s\n", $$1, $$2}'

.PHONY: build
build: ## Build the binary.
	${MKDIR_P} bin/
	CGO_ENABLED=0 go build -ldflags "\
	  -X ${VERSION_PATH}.version=${VERSION} \
		-X ${VERSION_PATH}.commit=${GIT_COMMIT} \
		-X ${VERSION_PATH}.date=${BUILD_DATE}" \
		-o bin/swmcp cmd/skywalking-mcp/main.go

.PHONY: test
test: ## Run unit tests.
	go test $(GO_TEST_FLAGS) $(GO_TEST_PKGS)

.PHONY: test-cover
test-cover: ## Run unit tests with coverage output in coverage.txt.
	go test $(GO_TEST_FLAGS) -coverprofile=coverage.txt $(GO_TEST_PKGS)

$(GO_LINT):
	@$(GO_LINT) version > /dev/null 2>&1 || go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.64.0
$(LICENSE_EYE):
	@$(LICENSE_EYE) --version > /dev/null 2>&1 || go install github.com/apache/skywalking-eyes/cmd/license-eye@latest

lint: $(GO_LINT) ## Run linter.
	$(GO_LINT) run -v --timeout 5m ./...

fix-lint: $(GO_LINT) ## Auto-fix lint issues.
	$(GO_LINT) run -v --fix ./...

.PHONY: license-header
license-header: $(LICENSE_EYE)
	@$(LICENSE_EYE) header check

.PHONY: fix-license-header
fix-license-header: $(LICENSE_EYE)
	@$(LICENSE_EYE) header fix

.PHONY: dependency-license
dependency-license: $(LICENSE_EYE)
	@rm -rf ./dist/licenses
	@$(LICENSE_EYE) dependency resolve --summary ./dist/LICENSE.tpl --output ./dist/licenses || exit 1
	@if [ ! -z "`git diff -U0 ./dist`" ]; then \
		echo "LICENSE file is not updated correctly"; \
		git diff -U0 ./dist; \
		exit 1; \
	fi

.PHONY: fix-dependency-license
fix-dependency-license: $(LICENSE_EYE)
	@$(LICENSE_EYE) dependency resolve --summary ./dist/LICENSE.tpl --output ./dist/licenses

.PHONY: fix-license
fix-license: fix-license-header fix-dependency-license

.PHONY: fix
fix: fix-lint fix-license

.PHONY: clean
clean:
	-rm -rf bin
	-rm -rf coverage.txt
	-rm -rf *.tgz
	-rm -rf *.asc
	-rm -rf *.sha512

.PHONY: build-image
build-image: docker-build ## Build the Docker image.

.PHONY: docker-build
docker-build: ## Build the Docker image with Buildx. Defaults to a local linux/amd64 image; override PLATFORMS/OUTPUT as needed.
	docker buildx build --platform $(PLATFORMS) \
		--build-arg VERSION=$(VERSION) \
		--build-arg GIT_COMMIT=$(GIT_COMMIT) \
		--build-arg BUILD_DATE=$(BUILD_DATE) \
		$(IMAGE_TAGS) \
		$(OUTPUT) .

.PHONY: docker-push
docker-push: ## Build and push multi-platform Docker images to the registry.
	$(MAKE) docker-build PLATFORMS=$(MULTI_PLATFORMS) OUTPUT=--push

.PHONY: docker-build-multi
docker-build-multi: ## Build a local multi-platform image index without pushing (requires OUTPUT like --output=type=oci,dest=...).
	$(MAKE) docker-build PLATFORMS=$(MULTI_PLATFORMS) OUTPUT='$(OUTPUT)'

.PHONY: docker
docker: docker-build

.PHONY: docker.push
docker.push: docker-push

## Release
RELEASE_SCRIPTS := ./scripts/release.sh

release-binary: release-source ## Package binary archive
	${RELEASE_SCRIPTS} -b

release-source: ## Package source archive
	${RELEASE_SCRIPTS} -s

release-sign: ## Sign artifacts
	${RELEASE_SCRIPTS} -k mcp

release-assembly: release-binary release-sign ## Generate release package

PUSH_RELEASE_SCRIPTS := ./scripts/push-release.sh
release-push-candidate:
	${PUSH_RELEASE_SCRIPTS}

.PHONY: lint fix-lint test test-cover
.PHONY: license-header fix-license-header dependency-license fix-dependency-license
.PHONY: release-binary release-source release-sign release-assembly
.PHONY: release-push-candidate docker-build-multi