Makefile - third_party/github/open-telemetry/opentelemetry-go - Git at Google


            
            # Copyright The OpenTelemetry Authors

            
            # SPDX-License-Identifier: Apache-2.0


            TOOLS_MOD_DIR := ./internal/tools


            ALL_DOCS := $(shell find . -name '*.md' -type f | sort)

            
            ALL_GO_MOD_DIRS := $(shell find . -type f -name 'go.mod' -exec dirname {} \; | sort)

            
            OTEL_GO_MOD_DIRS := $(filter-out $(TOOLS_MOD_DIR), $(ALL_GO_MOD_DIRS))

            
            ALL_COVERAGE_MOD_DIRS := $(shell find . -type f -name 'go.mod' -exec dirname {} \; | grep -E -v '^./example|^$(TOOLS_MOD_DIR)' | sort)


            GO = go

            
            TIMEOUT = 60

            
            GO_VERSION := $(shell awk '/^go [0-9]/ {print $$2; exit}' go.mod)


            # User to run as in docker images.

            
            DOCKER_USER=$(shell id -u):$(shell id -g)

            
            DEPENDENCIES_DOCKERFILE=./dependencies.Dockerfile


            .DEFAULT_GOAL := precommit


            .PHONY: precommit ci

            
            precommit: generate toolchain-check license-check misspell go-mod-tidy golangci-lint-fix verify-readmes verify-mods test-default

            
            ci: generate toolchain-check license-check lint verify-readmes verify-mods build test-default check-clean-work-tree test-coverage


            # Tools


            TOOLS = $(CURDIR)/.tools


            $(TOOLS):

            
            	@mkdir -p $@

            
            $(TOOLS)/%: $(TOOLS_MOD_DIR)/go.mod | $(TOOLS)

            
            	cd $(TOOLS_MOD_DIR) && \

            
            	$(GO) build -o $@ $(PACKAGE)


            MULTIMOD = $(TOOLS)/multimod

            
            $(TOOLS)/multimod: PACKAGE=go.opentelemetry.io/build-tools/multimod


            CROSSLINK = $(TOOLS)/crosslink

            
            $(TOOLS)/crosslink: PACKAGE=go.opentelemetry.io/build-tools/crosslink


            SEMCONVKIT = $(TOOLS)/semconvkit

            
            SEMCONVKIT_FILES := $(sort $(shell find $(TOOLS_MOD_DIR)/semconvkit -type f))

            
            $(TOOLS)/semconvkit: PACKAGE=go.opentelemetry.io/otel/$(TOOLS_MOD_DIR)/semconvkit

            
            $(TOOLS)/semconvkit: $(SEMCONVKIT_FILES)


            VERIFYREADMES = $(TOOLS)/verifyreadmes

            
            VERIFYREADMES_FILES := $(sort $(shell find $(TOOLS_MOD_DIR)/verifyreadmes -type f))

            
            $(TOOLS)/verifyreadmes: PACKAGE=go.opentelemetry.io/otel/$(TOOLS_MOD_DIR)/verifyreadmes

            
            $(TOOLS)/verifyreadmes: $(VERIFYREADMES_FILES)


            GOLANGCI_LINT = $(TOOLS)/golangci-lint

            
            $(TOOLS)/golangci-lint: PACKAGE=github.com/golangci/golangci-lint/v2/cmd/golangci-lint


            MISSPELL = $(TOOLS)/misspell

            
            $(TOOLS)/misspell: PACKAGE=github.com/client9/misspell/cmd/misspell


            GOCOVMERGE = $(TOOLS)/gocovmerge

            
            $(TOOLS)/gocovmerge: PACKAGE=github.com/wadey/gocovmerge


            STRINGER = $(TOOLS)/stringer

            
            $(TOOLS)/stringer: PACKAGE=golang.org/x/tools/cmd/stringer


            GOTMPL = $(TOOLS)/gotmpl

            
            $(GOTMPL): PACKAGE=go.opentelemetry.io/build-tools/gotmpl


            GORELEASE = $(TOOLS)/gorelease

            
            $(GORELEASE): PACKAGE=golang.org/x/exp/cmd/gorelease


            GOVULNCHECK = $(TOOLS)/govulncheck

            
            $(TOOLS)/govulncheck: PACKAGE=golang.org/x/vuln/cmd/govulncheck


            AFFECTEDMODS = $(TOOLS)/affectedmods

            
            AFFECTEDMODS_FILES := $(sort $(shell find $(TOOLS_MOD_DIR)/affectedmods -type f))

            
            $(TOOLS)/affectedmods: PACKAGE=go.opentelemetry.io/otel/$(TOOLS_MOD_DIR)/affectedmods

            
            $(TOOLS)/affectedmods: $(AFFECTEDMODS_FILES)


            .PHONY: tools

            
            tools: $(CROSSLINK) $(GOLANGCI_LINT) $(MISSPELL) $(GOCOVMERGE) $(STRINGER) $(VERIFYREADMES) $(MULTIMOD) $(SEMCONVKIT) $(GOTMPL) $(GORELEASE) $(AFFECTEDMODS)


            # Virtualized python tools via docker


            # The directory where the virtual environment is created.

            
            VENVDIR := venv


            # The directory where the python tools are installed.

            
            PYTOOLS := $(VENVDIR)/bin


            # The pip executable in the virtual environment.

            
            PIP := $(PYTOOLS)/pip


            # The directory in the docker image where the current directory is mounted.

            
            WORKDIR := /workdir


            # The python image to use for the virtual environment.

            
            PYTHONIMAGE := $(shell awk '$$4=="python" {print $$2}' $(DEPENDENCIES_DOCKERFILE))


            # Run the python image with the current directory mounted.

            
            DOCKERPY := docker run --rm -u $(DOCKER_USER) -v "$(CURDIR):$(WORKDIR)" -w $(WORKDIR) $(PYTHONIMAGE)


            # Create a virtual environment for Python tools.

            
            $(PYTOOLS):

            
            # The `--upgrade` flag is needed to ensure that the virtual environment is

            
            # created with the latest pip version.

            
            	@$(DOCKERPY) bash -c "python3 -m venv $(VENVDIR) && $(PIP) install --upgrade --cache-dir=$(WORKDIR)/.cache/pip pip"


            # Install python packages into the virtual environment.

            
            $(PYTOOLS)/%: $(PYTOOLS)

            
            	@$(DOCKERPY) $(PIP) install --cache-dir=$(WORKDIR)/.cache/pip -r requirements.txt


            CODESPELL = $(PYTOOLS)/codespell

            
            $(CODESPELL): PACKAGE=codespell


            # Generate


            .PHONY: generate

            
            generate: go-generate


            .PHONY: go-generate

            
            go-generate: $(OTEL_GO_MOD_DIRS:%=go-generate/%)

            
            go-generate/%: DIR=$*

            
            go-generate/%: $(STRINGER) $(GOTMPL)

            
            	@echo "$(GO) generate $(DIR)/..." \

            
            		&& cd $(DIR) \

            
            		&& PATH="$(TOOLS):$${PATH}" $(GO) generate ./...


            # Generate go.work file for local development.

            
            .PHONY: go-work

            
            go-work: $(CROSSLINK)

            
            	$(CROSSLINK) work --root=$(shell pwd) --go=$(GO_VERSION)


            # Build


            .PHONY: build cross-build


            build: $(OTEL_GO_MOD_DIRS:%=build/%) $(OTEL_GO_MOD_DIRS:%=build-tests/%)

            
            # Cross-platform builds cannot execute the binaries produced by build-tests (go test), so use a compile-only target.

            
            cross-build: $(OTEL_GO_MOD_DIRS:%=build/%)

            
            build/%: DIR=$*

            
            build/%:

            
            	@echo "$(GO) build $(DIR)/..." \

            
            		&& cd $(DIR) \

            
            		&& $(GO) build ./...


            build-tests/%: DIR=$*

            
            build-tests/%:

            
            	@echo "$(GO) build tests $(DIR)/..." \

            
            		&& cd $(DIR) \

            
            		&& $(GO) list ./... \

            
            		| grep -v third_party \

            
            		| xargs $(GO) test -vet=off -run xxxxxMatchNothingxxxxx >/dev/null


            # Tests


            TEST_TARGETS := test-default test-bench test-short test-verbose test-race test-concurrent-safe test-fuzz

            
            .PHONY: $(TEST_TARGETS) test

            
            test-default test-race: ARGS=-race

            
            test-bench:   ARGS=-run=xxxxxMatchNothingxxxxx -test.benchtime=1ms -bench=.

            
            test-short:   ARGS=-short

            
            test-fuzz:    ARGS=-fuzztime=10s -fuzz

            
            test-verbose: ARGS=-v -race

            
            test-concurrent-safe: ARGS=-run=ConcurrentSafe -count=100 -race

            
            test-concurrent-safe: TIMEOUT=120

            
            $(TEST_TARGETS): test

            
            test: $(OTEL_GO_MOD_DIRS:%=test/%)

            
            test/%: DIR=$*

            
            test/%:

            
            	@echo "$(GO) test -timeout $(TIMEOUT)s $(ARGS) $(DIR)/..." \

            
            		&& cd $(DIR) \

            
            		&& $(GO) list ./... \

            
            		| grep -v third_party \

            
            		| xargs $(GO) test -timeout $(TIMEOUT)s $(ARGS)


            .PHONY: test-tools

            
            test-tools: test/$(TOOLS_MOD_DIR)


            COVERAGE_MODE    = atomic

            
            COVERAGE_PROFILE = coverage.out

            
            .PHONY: test-coverage

            
            test-coverage: $(GOCOVMERGE)

            
            	@set -e; \

            
            	printf "" > coverage.txt; \

            
            	for dir in $(ALL_COVERAGE_MOD_DIRS); do \

            
            	  echo "$(GO) test -coverpkg=go.opentelemetry.io/otel/... -covermode=$(COVERAGE_MODE) -coverprofile="$(COVERAGE_PROFILE)" $${dir}/..."; \

            
            	  (cd "$${dir}" && \

            
            	    $(GO) list ./... \

            
            	    | grep -v third_party \

            
            	    | grep -v 'semconv/v.*' \

            
            	    | xargs $(GO) test -coverpkg=./... -covermode=$(COVERAGE_MODE) -coverprofile="$(COVERAGE_PROFILE)" && \

            
            	  $(GO) tool cover -html=coverage.out -o coverage.html); \

            
            	done; \

            
            	$(GOCOVMERGE) $$(find . -name coverage.out) > coverage.txt


            .PHONY: benchmark

            
            benchmark: $(OTEL_GO_MOD_DIRS:%=benchmark/%)

            
            benchmark/%:

            
            	cd $* && $(GO) test -run='^$$' -bench=. $(ARGS) ./...


            # sdk/metric is split into two shards to work around CodSpeed limitations.

            
            # See https://github.com/CodSpeedHQ/codspeed-go/issues/56

            
            BENCHMARK_SHARDS := $(filter-out ./sdk/metric,$(OTEL_GO_MOD_DIRS)) ./sdk/metric/. ./sdk/metric/internal

            
            benchmark/./sdk/metric/.:

            
            	cd ./sdk/metric && $(GO) test -run='^$$' -bench=. $(ARGS) . ./exemplar/...


            print-sharded-benchmarks:

            
            	@echo $(BENCHMARK_SHARDS) | jq -cR 'split(" ")'


            # Print the JSON list of benchmark shards whose code changed since

            
            # BASE_REF (default: main). Filters print-sharded-benchmarks

            
            # down to shards whose underlying module contains a changed *.go file.

            
            # Non-Go changes (docs, workflows, Makefile, go.mod/go.sum, tooling) emit [].

            
            # Override the diff base via BASE_REF, or pass ARGS=-all to emit the full list.

            
            BASE_REF ?= main

            
            .PHONY: print-affected-benchmarks

            
            print-affected-benchmarks:

            
            	@$(MAKE) -s print-sharded-benchmarks | $(GO) -C $(TOOLS_MOD_DIR) run ./affectedmods $(if $(strip $(BASE_REF)),-base=$(BASE_REF),) $(ARGS)


            .PHONY: golangci-lint golangci-lint-fix

            
            golangci-lint-fix: ARGS=--fix

            
            golangci-lint-fix: golangci-lint

            
            golangci-lint: $(OTEL_GO_MOD_DIRS:%=golangci-lint/%)

            
            golangci-lint/%: DIR=$*

            
            golangci-lint/%: $(GOLANGCI_LINT)

            
            	@echo 'golangci-lint $(if $(ARGS),$(ARGS) ,)$(DIR)' \

            
            		&& cd $(DIR) \

            
            		&& $(GOLANGCI_LINT) run --allow-serial-runners $(ARGS)


            .PHONY: crosslink

            
            crosslink: $(CROSSLINK)

            
            	@echo "Updating intra-repository dependencies in all go modules" \

            
            		&& $(CROSSLINK) --root=$(shell pwd) --prune


            .PHONY: go-mod-tidy

            
            go-mod-tidy: $(ALL_GO_MOD_DIRS:%=go-mod-tidy/%)

            
            go-mod-tidy/%: DIR=$*

            
            go-mod-tidy/%: crosslink

            
            	@echo "$(GO) mod tidy in $(DIR)" \

            
            		&& cd $(DIR) \

            
            		&& $(GO) mod tidy -compat=1.21


            .PHONY: lint

            
            lint: misspell go-mod-tidy golangci-lint


            .PHONY: misspell

            
            misspell: $(MISSPELL)

            
            	@$(MISSPELL) -w $(ALL_DOCS)


            .PHONY: govulncheck

            
            govulncheck: $(OTEL_GO_MOD_DIRS:%=govulncheck/%)

            
            govulncheck/%: DIR=$*

            
            govulncheck/%: $(GOVULNCHECK)

            
            	@echo "govulncheck ./... in $(DIR)" \

            
            		&& cd $(DIR) \

            
            		&& $(GOVULNCHECK) ./...


            .PHONY: codespell

            
            codespell: $(CODESPELL)

            
            	@$(DOCKERPY) $(CODESPELL)


            .PHONY: toolchain-check

            
            toolchain-check:

            
            	@toolchainRes=$$(for f in $(ALL_GO_MOD_DIRS); do \

            
            	           awk '/^toolchain/ { found=1; next } END { if (found) print FILENAME }' $$f/go.mod; \

            
            	done); \

            
            	if [ -n "$${toolchainRes}" ]; then \

            
            			echo "toolchain checking failed:"; echo "$${toolchainRes}"; \

            
            			exit 1; \

            
            	fi


            .PHONY: license-check

            
            license-check:

            
            	@licRes=$$(for f in $$(find . -type f \( -iname '*.go' -o -iname '*.sh' \) ! -path '**/third_party/*' ! -path './.git/*' ) ; do \

            
            	           awk '/Copyright The OpenTelemetry Authors|generated|GENERATED/ && NR<=4 { found=1; next } END { if (!found) print FILENAME }' $$f; \

            
            	   done); \

            
            	   if [ -n "$${licRes}" ]; then \

            
            	           echo "license header checking failed:"; echo "$${licRes}"; \

            
            	           exit 1; \

            
            	   fi


            .PHONY: check-clean-work-tree

            
            check-clean-work-tree:

            
            	@if ! git diff --quiet; then \

            
            	  echo; \

            
            	  echo 'Working tree is not clean, did you forget to run "make precommit"?'; \

            
            	  echo; \

            
            	  git status; \

            
            	  exit 1; \

            
            	fi


            # The weaver docker image to use for semconv-generate.

            
            WEAVER_IMAGE := $(shell awk '$$4=="weaver" {print $$2}' $(DEPENDENCIES_DOCKERFILE))


            SEMCONVPKG ?= "semconv/"

            
            .PHONY: semconv-generate

            
            semconv-generate: $(SEMCONVKIT)

            
            	[ "$(TAG)" ] || ( echo "TAG unset: missing opentelemetry semantic-conventions tag"; exit 1 )

            
            	# Ensure the target directory for source code is available.

            
            	mkdir -p $(PWD)/$(SEMCONVPKG)/${TAG}

            
            	# Note: We mount a home directory for downloading/storing the semconv repository.

            
            	# Weaver will automatically clean the cache when finished, but the directories will remain.

            
            	mkdir -p ~/.weaver

            
            	docker run --rm \

            
            		-u $(DOCKER_USER) \

            
            		--env HOME=/tmp/weaver \

            
            		--mount 'type=bind,source=$(PWD)/semconv/templates,target=/home/weaver/templates,readonly' \

            
            		--mount 'type=bind,source=$(PWD)/semconv/${TAG},target=/home/weaver/target' \

            
            		--mount 'type=bind,source=$(HOME)/.weaver,target=/tmp/weaver/.weaver' \

            
            		$(WEAVER_IMAGE) registry generate \

            
            		--registry=https://github.com/open-telemetry/semantic-conventions/archive/refs/tags/$(TAG).zip[model] \

            
            		--templates=/home/weaver/templates \

            
            		--param tag=$(TAG) \

            
            		go \

            
            		/home/weaver/target

            
            	$(SEMCONVKIT) -semconv "$(SEMCONVPKG)" -tag "$(TAG)"


            .PHONY: gorelease

            
            gorelease: $(OTEL_GO_MOD_DIRS:%=gorelease/%)

            
            gorelease/%: DIR=$*

            
            gorelease/%:| $(GORELEASE)

            
            	@echo "gorelease in $(DIR):" \

            
            		&& cd $(DIR) \

            
            		&& $(GORELEASE) \

            
            		|| echo ""


            .PHONY: verify-mods

            
            verify-mods: $(MULTIMOD)

            
            	$(MULTIMOD) verify


            .PHONY: prerelease

            
            prerelease: verify-mods

            
            	@[ "${MODSET}" ] || ( echo ">> env var MODSET is not set"; exit 1 )

            
            	$(MULTIMOD) prerelease -m ${MODSET}


            COMMIT ?= "HEAD"

            
            .PHONY: add-tags

            
            add-tags: verify-mods

            
            	@[ "${MODSET}" ] || ( echo ">> env var MODSET is not set"; exit 1 )

            
            	$(MULTIMOD) tag -m ${MODSET} -c ${COMMIT}


            MARKDOWNIMAGE := $(shell awk '$$4=="markdown" {print $$2}' $(DEPENDENCIES_DOCKERFILE))

            
            .PHONY: lint-markdown

            
            lint-markdown:

            
            	docker run --rm -u $(DOCKER_USER) -v "$(CURDIR):$(WORKDIR)" $(MARKDOWNIMAGE) -c $(WORKDIR)/.markdownlint.yaml $(WORKDIR)/**/*.md


            .PHONY: verify-readmes

            
            verify-readmes: $(VERIFYREADMES)

            
            	$(VERIFYREADMES)
	# Copyright The OpenTelemetry Authors
	# SPDX-License-Identifier: Apache-2.0

	TOOLS_MOD_DIR := ./internal/tools

	ALL_DOCS := $(shell find . -name '*.md' -type f \| sort)
	ALL_GO_MOD_DIRS := $(shell find . -type f -name 'go.mod' -exec dirname {} \; \| sort)
	OTEL_GO_MOD_DIRS := $(filter-out $(TOOLS_MOD_DIR), $(ALL_GO_MOD_DIRS))
	ALL_COVERAGE_MOD_DIRS := $(shell find . -type f -name 'go.mod' -exec dirname {} \; \| grep -E -v '^./example\|^$(TOOLS_MOD_DIR)' \| sort)

	GO = go
	TIMEOUT = 60
	GO_VERSION := $(shell awk '/^go [0-9]/ {print $$2; exit}' go.mod)

	# User to run as in docker images.
	DOCKER_USER=$(shell id -u):$(shell id -g)
	DEPENDENCIES_DOCKERFILE=./dependencies.Dockerfile

	.DEFAULT_GOAL := precommit

	.PHONY: precommit ci
	precommit: generate toolchain-check license-check misspell go-mod-tidy golangci-lint-fix verify-readmes verify-mods test-default
	ci: generate toolchain-check license-check lint verify-readmes verify-mods build test-default check-clean-work-tree test-coverage

	# Tools

	TOOLS = $(CURDIR)/.tools

	$(TOOLS):
	@mkdir -p $@
	$(TOOLS)/%: $(TOOLS_MOD_DIR)/go.mod \| $(TOOLS)
	cd $(TOOLS_MOD_DIR) && \
	$(GO) build -o $@ $(PACKAGE)

	MULTIMOD = $(TOOLS)/multimod
	$(TOOLS)/multimod: PACKAGE=go.opentelemetry.io/build-tools/multimod

	CROSSLINK = $(TOOLS)/crosslink
	$(TOOLS)/crosslink: PACKAGE=go.opentelemetry.io/build-tools/crosslink

	SEMCONVKIT = $(TOOLS)/semconvkit
	SEMCONVKIT_FILES := $(sort $(shell find $(TOOLS_MOD_DIR)/semconvkit -type f))
	$(TOOLS)/semconvkit: PACKAGE=go.opentelemetry.io/otel/$(TOOLS_MOD_DIR)/semconvkit
	$(TOOLS)/semconvkit: $(SEMCONVKIT_FILES)

	VERIFYREADMES = $(TOOLS)/verifyreadmes
	VERIFYREADMES_FILES := $(sort $(shell find $(TOOLS_MOD_DIR)/verifyreadmes -type f))
	$(TOOLS)/verifyreadmes: PACKAGE=go.opentelemetry.io/otel/$(TOOLS_MOD_DIR)/verifyreadmes
	$(TOOLS)/verifyreadmes: $(VERIFYREADMES_FILES)

	GOLANGCI_LINT = $(TOOLS)/golangci-lint
	$(TOOLS)/golangci-lint: PACKAGE=github.com/golangci/golangci-lint/v2/cmd/golangci-lint

	MISSPELL = $(TOOLS)/misspell
	$(TOOLS)/misspell: PACKAGE=github.com/client9/misspell/cmd/misspell

	GOCOVMERGE = $(TOOLS)/gocovmerge
	$(TOOLS)/gocovmerge: PACKAGE=github.com/wadey/gocovmerge

	STRINGER = $(TOOLS)/stringer
	$(TOOLS)/stringer: PACKAGE=golang.org/x/tools/cmd/stringer

	GOTMPL = $(TOOLS)/gotmpl
	$(GOTMPL): PACKAGE=go.opentelemetry.io/build-tools/gotmpl

	GORELEASE = $(TOOLS)/gorelease
	$(GORELEASE): PACKAGE=golang.org/x/exp/cmd/gorelease

	GOVULNCHECK = $(TOOLS)/govulncheck
	$(TOOLS)/govulncheck: PACKAGE=golang.org/x/vuln/cmd/govulncheck

	AFFECTEDMODS = $(TOOLS)/affectedmods
	AFFECTEDMODS_FILES := $(sort $(shell find $(TOOLS_MOD_DIR)/affectedmods -type f))
	$(TOOLS)/affectedmods: PACKAGE=go.opentelemetry.io/otel/$(TOOLS_MOD_DIR)/affectedmods
	$(TOOLS)/affectedmods: $(AFFECTEDMODS_FILES)

	.PHONY: tools
	tools: $(CROSSLINK) $(GOLANGCI_LINT) $(MISSPELL) $(GOCOVMERGE) $(STRINGER) $(VERIFYREADMES) $(MULTIMOD) $(SEMCONVKIT) $(GOTMPL) $(GORELEASE) $(AFFECTEDMODS)

	# Virtualized python tools via docker

	# The directory where the virtual environment is created.
	VENVDIR := venv

	# The directory where the python tools are installed.
	PYTOOLS := $(VENVDIR)/bin

	# The pip executable in the virtual environment.
	PIP := $(PYTOOLS)/pip

	# The directory in the docker image where the current directory is mounted.
	WORKDIR := /workdir

	# The python image to use for the virtual environment.
	PYTHONIMAGE := $(shell awk '$$4=="python" {print $$2}' $(DEPENDENCIES_DOCKERFILE))

	# Run the python image with the current directory mounted.
	DOCKERPY := docker run --rm -u $(DOCKER_USER) -v "$(CURDIR):$(WORKDIR)" -w $(WORKDIR) $(PYTHONIMAGE)

	# Create a virtual environment for Python tools.
	$(PYTOOLS):
	# The `--upgrade` flag is needed to ensure that the virtual environment is
	# created with the latest pip version.
	@$(DOCKERPY) bash -c "python3 -m venv $(VENVDIR) && $(PIP) install --upgrade --cache-dir=$(WORKDIR)/.cache/pip pip"

	# Install python packages into the virtual environment.
	$(PYTOOLS)/%: $(PYTOOLS)
	@$(DOCKERPY) $(PIP) install --cache-dir=$(WORKDIR)/.cache/pip -r requirements.txt

	CODESPELL = $(PYTOOLS)/codespell
	$(CODESPELL): PACKAGE=codespell

	# Generate

	.PHONY: generate
	generate: go-generate

	.PHONY: go-generate
	go-generate: $(OTEL_GO_MOD_DIRS:%=go-generate/%)
	go-generate/%: DIR=$*
	go-generate/%: $(STRINGER) $(GOTMPL)
	@echo "$(GO) generate $(DIR)/..." \
	&& cd $(DIR) \
	&& PATH="$(TOOLS):$${PATH}" $(GO) generate ./...

	# Generate go.work file for local development.
	.PHONY: go-work
	go-work: $(CROSSLINK)
	$(CROSSLINK) work --root=$(shell pwd) --go=$(GO_VERSION)

	# Build

	.PHONY: build cross-build

	build: $(OTEL_GO_MOD_DIRS:%=build/%) $(OTEL_GO_MOD_DIRS:%=build-tests/%)
	# Cross-platform builds cannot execute the binaries produced by build-tests (go test), so use a compile-only target.
	cross-build: $(OTEL_GO_MOD_DIRS:%=build/%)
	build/%: DIR=$*
	build/%:
	@echo "$(GO) build $(DIR)/..." \
	&& cd $(DIR) \
	&& $(GO) build ./...

	build-tests/%: DIR=$*
	build-tests/%:
	@echo "$(GO) build tests $(DIR)/..." \
	&& cd $(DIR) \
	&& $(GO) list ./... \
	\| grep -v third_party \
	\| xargs $(GO) test -vet=off -run xxxxxMatchNothingxxxxx >/dev/null

	# Tests

	TEST_TARGETS := test-default test-bench test-short test-verbose test-race test-concurrent-safe test-fuzz
	.PHONY: $(TEST_TARGETS) test
	test-default test-race: ARGS=-race
	test-bench: ARGS=-run=xxxxxMatchNothingxxxxx -test.benchtime=1ms -bench=.
	test-short: ARGS=-short
	test-fuzz: ARGS=-fuzztime=10s -fuzz
	test-verbose: ARGS=-v -race
	test-concurrent-safe: ARGS=-run=ConcurrentSafe -count=100 -race
	test-concurrent-safe: TIMEOUT=120
	$(TEST_TARGETS): test
	test: $(OTEL_GO_MOD_DIRS:%=test/%)
	test/%: DIR=$*
	test/%:
	@echo "$(GO) test -timeout $(TIMEOUT)s $(ARGS) $(DIR)/..." \
	&& cd $(DIR) \
	&& $(GO) list ./... \
	\| grep -v third_party \
	\| xargs $(GO) test -timeout $(TIMEOUT)s $(ARGS)

	.PHONY: test-tools
	test-tools: test/$(TOOLS_MOD_DIR)

	COVERAGE_MODE = atomic
	COVERAGE_PROFILE = coverage.out
	.PHONY: test-coverage
	test-coverage: $(GOCOVMERGE)
	@set -e; \
	printf "" > coverage.txt; \
	for dir in $(ALL_COVERAGE_MOD_DIRS); do \
	echo "$(GO) test -coverpkg=go.opentelemetry.io/otel/... -covermode=$(COVERAGE_MODE) -coverprofile="$(COVERAGE_PROFILE)" $${dir}/..."; \
	(cd "$${dir}" && \
	$(GO) list ./... \
	\| grep -v third_party \
	\| grep -v 'semconv/v.*' \
	\| xargs $(GO) test -coverpkg=./... -covermode=$(COVERAGE_MODE) -coverprofile="$(COVERAGE_PROFILE)" && \
	$(GO) tool cover -html=coverage.out -o coverage.html); \
	done; \
	$(GOCOVMERGE) $$(find . -name coverage.out) > coverage.txt

	.PHONY: benchmark
	benchmark: $(OTEL_GO_MOD_DIRS:%=benchmark/%)
	benchmark/%:
	cd $* && $(GO) test -run='^$$' -bench=. $(ARGS) ./...

	# sdk/metric is split into two shards to work around CodSpeed limitations.
	# See https://github.com/CodSpeedHQ/codspeed-go/issues/56
	BENCHMARK_SHARDS := $(filter-out ./sdk/metric,$(OTEL_GO_MOD_DIRS)) ./sdk/metric/. ./sdk/metric/internal
	benchmark/./sdk/metric/.:
	cd ./sdk/metric && $(GO) test -run='^$$' -bench=. $(ARGS) . ./exemplar/...

	print-sharded-benchmarks:
	@echo $(BENCHMARK_SHARDS) \| jq -cR 'split(" ")'

	# Print the JSON list of benchmark shards whose code changed since
	# BASE_REF (default: main). Filters print-sharded-benchmarks
	# down to shards whose underlying module contains a changed *.go file.
	# Non-Go changes (docs, workflows, Makefile, go.mod/go.sum, tooling) emit [].
	# Override the diff base via BASE_REF, or pass ARGS=-all to emit the full list.
	BASE_REF ?= main
	.PHONY: print-affected-benchmarks
	print-affected-benchmarks:
	@$(MAKE) -s print-sharded-benchmarks \| $(GO) -C $(TOOLS_MOD_DIR) run ./affectedmods $(if $(strip $(BASE_REF)),-base=$(BASE_REF),) $(ARGS)

	.PHONY: golangci-lint golangci-lint-fix
	golangci-lint-fix: ARGS=--fix
	golangci-lint-fix: golangci-lint
	golangci-lint: $(OTEL_GO_MOD_DIRS:%=golangci-lint/%)
	golangci-lint/%: DIR=$*
	golangci-lint/%: $(GOLANGCI_LINT)
	@echo 'golangci-lint $(if $(ARGS),$(ARGS) ,)$(DIR)' \
	&& cd $(DIR) \
	&& $(GOLANGCI_LINT) run --allow-serial-runners $(ARGS)

	.PHONY: crosslink
	crosslink: $(CROSSLINK)
	@echo "Updating intra-repository dependencies in all go modules" \
	&& $(CROSSLINK) --root=$(shell pwd) --prune

	.PHONY: go-mod-tidy
	go-mod-tidy: $(ALL_GO_MOD_DIRS:%=go-mod-tidy/%)
	go-mod-tidy/%: DIR=$*
	go-mod-tidy/%: crosslink
	@echo "$(GO) mod tidy in $(DIR)" \
	&& cd $(DIR) \
	&& $(GO) mod tidy -compat=1.21

	.PHONY: lint
	lint: misspell go-mod-tidy golangci-lint

	.PHONY: misspell
	misspell: $(MISSPELL)
	@$(MISSPELL) -w $(ALL_DOCS)

	.PHONY: govulncheck
	govulncheck: $(OTEL_GO_MOD_DIRS:%=govulncheck/%)
	govulncheck/%: DIR=$*
	govulncheck/%: $(GOVULNCHECK)
	@echo "govulncheck ./... in $(DIR)" \
	&& cd $(DIR) \
	&& $(GOVULNCHECK) ./...

	.PHONY: codespell
	codespell: $(CODESPELL)
	@$(DOCKERPY) $(CODESPELL)

	.PHONY: toolchain-check
	toolchain-check:
	@toolchainRes=$$(for f in $(ALL_GO_MOD_DIRS); do \
	awk '/^toolchain/ { found=1; next } END { if (found) print FILENAME }' $$f/go.mod; \
	done); \
	if [ -n "$${toolchainRes}" ]; then \
	echo "toolchain checking failed:"; echo "$${toolchainRes}"; \
	exit 1; \
	fi

	.PHONY: license-check
	license-check:
	@licRes=$$(for f in $$(find . -type f \( -iname '.go' -o -iname '.sh' \) ! -path '*/third_party/' ! -path './.git/*' ) ; do \
	awk '/Copyright The OpenTelemetry Authors\|generated\|GENERATED/ && NR<=4 { found=1; next } END { if (!found) print FILENAME }' $$f; \
	done); \
	if [ -n "$${licRes}" ]; then \
	echo "license header checking failed:"; echo "$${licRes}"; \
	exit 1; \
	fi

	.PHONY: check-clean-work-tree
	check-clean-work-tree:
	@if ! git diff --quiet; then \
	echo; \
	echo 'Working tree is not clean, did you forget to run "make precommit"?'; \
	echo; \
	git status; \
	exit 1; \
	fi

	# The weaver docker image to use for semconv-generate.
	WEAVER_IMAGE := $(shell awk '$$4=="weaver" {print $$2}' $(DEPENDENCIES_DOCKERFILE))

	SEMCONVPKG ?= "semconv/"
	.PHONY: semconv-generate
	semconv-generate: $(SEMCONVKIT)
	[ "$(TAG)" ] \|\| ( echo "TAG unset: missing opentelemetry semantic-conventions tag"; exit 1 )
	# Ensure the target directory for source code is available.
	mkdir -p $(PWD)/$(SEMCONVPKG)/${TAG}
	# Note: We mount a home directory for downloading/storing the semconv repository.
	# Weaver will automatically clean the cache when finished, but the directories will remain.
	mkdir -p ~/.weaver
	docker run --rm \
	-u $(DOCKER_USER) \
	--env HOME=/tmp/weaver \
	--mount 'type=bind,source=$(PWD)/semconv/templates,target=/home/weaver/templates,readonly' \
	--mount 'type=bind,source=$(PWD)/semconv/${TAG},target=/home/weaver/target' \
	--mount 'type=bind,source=$(HOME)/.weaver,target=/tmp/weaver/.weaver' \
	$(WEAVER_IMAGE) registry generate \
	--registry=https://github.com/open-telemetry/semantic-conventions/archive/refs/tags/$(TAG).zip[model] \
	--templates=/home/weaver/templates \
	--param tag=$(TAG) \
	go \
	/home/weaver/target
	$(SEMCONVKIT) -semconv "$(SEMCONVPKG)" -tag "$(TAG)"

	.PHONY: gorelease
	gorelease: $(OTEL_GO_MOD_DIRS:%=gorelease/%)
	gorelease/%: DIR=$*
	gorelease/%:\| $(GORELEASE)
	@echo "gorelease in $(DIR):" \
	&& cd $(DIR) \
	&& $(GORELEASE) \
	\|\| echo ""

	.PHONY: verify-mods
	verify-mods: $(MULTIMOD)
	$(MULTIMOD) verify

	.PHONY: prerelease
	prerelease: verify-mods
	@[ "${MODSET}" ] \|\| ( echo ">> env var MODSET is not set"; exit 1 )
	$(MULTIMOD) prerelease -m ${MODSET}

	COMMIT ?= "HEAD"
	.PHONY: add-tags
	add-tags: verify-mods
	@[ "${MODSET}" ] \|\| ( echo ">> env var MODSET is not set"; exit 1 )
	$(MULTIMOD) tag -m ${MODSET} -c ${COMMIT}

	MARKDOWNIMAGE := $(shell awk '$$4=="markdown" {print $$2}' $(DEPENDENCIES_DOCKERFILE))
	.PHONY: lint-markdown
	lint-markdown:
	docker run --rm -u $(DOCKER_USER) -v "$(CURDIR):$(WORKDIR)" $(MARKDOWNIMAGE) -c $(WORKDIR)/.markdownlint.yaml $(WORKDIR)/*/.md

	.PHONY: verify-readmes
	verify-readmes: $(VERIFYREADMES)
	$(VERIFYREADMES)