use the Makefile.common #3978
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| # 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 ">> Runnig 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 = $(shell $(GO) list ./... | grep -v /vendor/) | ||
|
|
||
| PREFIX ?= $(shell pwd) | ||
| BIN_DIR ?= $(shell pwd) | ||
| DOCKER_IMAGE_TAG ?= $(subst /,-,$(shell git rev-parse --abbrev-ref HEAD)) | ||
|
|
||
| all: format staticcheck unused build test | ||
|
|
||
| style: | ||
| @echo ">> checking code style" | ||
| ! $(GOFMT) -d $$(find . -path ./vendor -prune -o -name '*.go' -print) | grep '^' | ||
|
Contributor
Author
There was a problem hiding this comment. yes at the moment the output is quite busy , but I will open another PR to simply |
||
|
|
||
| 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 | ||
|
|
||
| test-short: | ||
| @echo ">> running short tests" | ||
| $(GO) test -short $(pkgs) | ||
|
|
||
| test: | ||
| @echo ">> running all tests" | ||
| $(GO) test -race $(pkgs) | ||
|
|
||
| format: | ||
| @echo ">> formatting code" | ||
| $(GO) fmt $(pkgs) | ||
|
|
||
| vet: | ||
| @echo ">> vetting code" | ||
| $(GO) vet $(pkgs) | ||
|
|
||
| staticcheck: $(STATICCHECK) | ||
| @echo ">> running staticcheck" | ||
| $(STATICCHECK) -ignore "$(STATICCHECK_IGNORE)" $(pkgs) | ||
|
|
||
| unused: $(GOVENDOR) | ||
| @echo ">> running check for unused packages" | ||
| @$(GOVENDOR) list +unused | ||
|
|
||
| build: promu | ||
| @echo ">> building binaries" | ||
| $(PROMU) build --prefix $(PREFIX) | ||
|
|
||
| tarball: promu | ||
| @echo ">> building release tarball" | ||
| $(PROMU) tarball --prefix $(PREFIX) $(BIN_DIR) | ||
|
|
||
| docker: | ||
| docker build -t "$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_TAG)" . | ||
|
|
||
| promu: | ||
| GOOS= GOARCH= $(GO) get -u github.com/prometheus/promu | ||
|
|
||
| $(FIRST_GOPATH)/bin/staticcheck: | ||
| GOOS= GOARCH= $(GO) get -u honnef.co/go/tools/cmd/staticcheck | ||
|
|
||
| $(FIRST_GOPATH)/bin/govendor: | ||
| GOOS= GOARCH= $(GO) get -u github.com/kardianos/govendor | ||
|
|
||
| .PHONY: all style check_license format build test vet assets tarball docker promu staticcheck $(FIRST_GOPATH)/bin/staticcheck govendor $(FIRST_GOPATH)/bin/govendor | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
alltarget should abort incorrectly formatted code, instead of silently formatting it. Replaceformatwithstyle.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should stay as-is as this is what a human will use. Maybe a separate CI target?
This is a matter for another PR in any case, we shouldn't be making changes here just refactoring.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All other targets abort the command and require the user to fix it, format is the only one behaving differently. Introducing another target is unnecessary and complicates all CI integrations which commonly just execute
make.This PR is explicitely labeled to introduce the new common Makefile for all projects, so either that needs to be changed or this is the PR where I have to request such changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is just a refactoring. Once it is in changes can be made before it is propagated out.