mirror of https://github.com/prometheus/prometheus
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
132 lines
4.0 KiB
132 lines
4.0 KiB
# Copyright 2018 The Prometheus Authors |
|
# Licensed 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. |
|
|
|
|
|
# A common Makefile that includes rules to be reused in different prometheus projects. |
|
# !!! Open PRs only against the prometheus/prometheus/Makefile.common repository! |
|
|
|
# Example usage : |
|
# Create the main Makefile in the root project directory. |
|
# include Makefile.common |
|
# customTarget: |
|
# @echo ">> Running customTarget" |
|
# |
|
|
|
# Ensure GOBIN is not set during build so that promu is installed to the correct path |
|
unexport GOBIN |
|
|
|
GO ?= go |
|
GOFMT ?= $(GO)fmt |
|
FIRST_GOPATH := $(firstword $(subst :, ,$(shell $(GO) env GOPATH))) |
|
PROMU := $(FIRST_GOPATH)/bin/promu |
|
STATICCHECK := $(FIRST_GOPATH)/bin/staticcheck |
|
GOVENDOR := $(FIRST_GOPATH)/bin/govendor |
|
pkgs = ./... |
|
|
|
PREFIX ?= $(shell pwd) |
|
BIN_DIR ?= $(shell pwd) |
|
DOCKER_IMAGE_TAG ?= $(subst /,-,$(shell git rev-parse --abbrev-ref HEAD)) |
|
DOCKER_REPO ?= prom |
|
|
|
.PHONY: all |
|
all: style staticcheck unused build test |
|
|
|
# This rule is used to forward a target like "build" to "common-build". This |
|
# allows a new "build" target to be defined in a Makefile which includes this |
|
# one and override "common-build" without override warnings. |
|
%: common-% ; |
|
|
|
.PHONY: common-style |
|
common-style: |
|
@echo ">> checking code style" |
|
@fmtRes=$$($(GOFMT) -d $$(find . -path ./vendor -prune -o -name '*.go' -print)); \ |
|
if [ -n "$${fmtRes}" ]; then \ |
|
echo "gofmt checking failed!"; echo "$${fmtRes}"; echo; \ |
|
echo "Please ensure you are using $$($(GO) version) for formatting code."; \ |
|
exit 1; \ |
|
fi |
|
|
|
.PHONY: common-check_license |
|
common-check_license: |
|
@echo ">> checking license header" |
|
@licRes=$$(for file in $$(find . -type f -iname '*.go' ! -path './vendor/*') ; do \ |
|
awk 'NR<=3' $$file | grep -Eq "(Copyright|generated|GENERATED)" || echo $$file; \ |
|
done); \ |
|
if [ -n "$${licRes}" ]; then \ |
|
echo "license header checking failed:"; echo "$${licRes}"; \ |
|
exit 1; \ |
|
fi |
|
|
|
.PHONY: common-test-short |
|
common-test-short: |
|
@echo ">> running short tests" |
|
$(GO) test -short $(pkgs) |
|
|
|
.PHONY: common-test |
|
common-test: |
|
@echo ">> running all tests" |
|
$(GO) test -race $(pkgs) |
|
|
|
.PHONY: common-format |
|
common-format: |
|
@echo ">> formatting code" |
|
$(GO) fmt $(pkgs) |
|
|
|
.PHONY: common-vet |
|
common-vet: |
|
@echo ">> vetting code" |
|
$(GO) vet $(pkgs) |
|
|
|
.PHONY: common-staticcheck |
|
common-staticcheck: $(STATICCHECK) |
|
@echo ">> running staticcheck" |
|
$(STATICCHECK) -ignore "$(STATICCHECK_IGNORE)" $(pkgs) |
|
|
|
.PHONY: common-unused |
|
common-unused: $(GOVENDOR) |
|
@echo ">> running check for unused packages" |
|
@$(GOVENDOR) list +unused | grep . && exit 1 || echo 'No unused packages' |
|
|
|
.PHONY: common-build |
|
common-build: promu |
|
@echo ">> building binaries" |
|
$(PROMU) build --prefix $(PREFIX) |
|
|
|
.PHONY: common-tarball |
|
common-tarball: promu |
|
@echo ">> building release tarball" |
|
$(PROMU) tarball --prefix $(PREFIX) $(BIN_DIR) |
|
|
|
.PHONY: common-docker |
|
common-docker: |
|
docker build -t "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_TAG)" . |
|
|
|
.PHONY: common-docker-publish |
|
common-docker-publish: |
|
docker push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)" |
|
|
|
.PHONY: common-docker-tag-latest |
|
common-docker-tag-latest: |
|
docker tag "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_TAG)" "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):latest" |
|
|
|
.PHONY: promu |
|
promu: |
|
GOOS= GOARCH= $(GO) get -u github.com/prometheus/promu |
|
|
|
.PHONY: $(STATICCHECK) |
|
$(STATICCHECK): |
|
GOOS= GOARCH= $(GO) get -u honnef.co/go/tools/cmd/staticcheck |
|
|
|
.PHONY: $(GOVENDOR) |
|
$(GOVENDOR): |
|
GOOS= GOARCH= $(GO) get -u github.com/kardianos/govendor
|
|
|