Clean up Makefile (#2924)

Add missing deprecated targets.  Remove `test` from `check` target since
we already have `test-race`.

Fixes #2901

diff --git a/.travis.yml b/.travis.yml
index 6d52843fa6fc0a46dbdbeeae44566b1555aae241..a43775d162880ab86d759dfe3ba5c9655ae902b4 100644 (file)
--- a/.travis.yml
+++ b/.travis.yml
@@ -12,12 +12,9 @@ matrix:
     - go: tip
   fast_finish: true
 install:
-  - make govendor
+  - make vendor
 script:
-  - make check
-  # Test 64-bit alignment on 32-bit builds
-  - env GOARCH=386 make test
-  - go build -race
+  - make hugo-race check
   - ./hugo -s docs/
   - ./hugo --renderToMemory -s docs/
 before_install:

diff --git a/Makefile b/Makefile
index 6d5aeed182fa1a84f6282cb2ed3a851c8ab3569c..6e6d4ec173ca7a154bcf4a3a68dd0449919c1e12 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,83 +1,80 @@
+# A Self-Documenting Makefile: http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
 
-# Adds build information from git repo
-#
-# as suggested by tatsushid in
-# https://github.com/spf13/hugo/issues/540
+PACKAGE = github.com/spf13/hugo
+COMMIT_HASH = `git rev-parse --short HEAD 2>/dev/null`
+BUILD_DATE = `date +%FT%T%z`
+LDFLAGS = -ldflags "-X ${PACKAGE}/hugolib.CommitHash=${COMMIT_HASH} -X ${PACKAGE}/hugolib.BuildDate=${BUILD_DATE}"
+NOGI_LDFLAGS = -ldflags "-X ${PACKAGE}/hugolib.BuildDate=${BUILD_DATE}"
 
-COMMIT_HASH=`git rev-parse --short HEAD 2>/dev/null`
-BUILD_DATE=`date +%FT%T%z`
-LDFLAGS=-ldflags "-X github.com/spf13/hugo/hugolib.CommitHash=${COMMIT_HASH} -X github.com/spf13/hugo/hugolib.BuildDate=${BUILD_DATE}"
-PACKAGES = $(shell govendor list -no-status +local | sed 's/github.com.spf13.hugo/./')
+.PHONY: vendor docker check fmt lint test test-race vet test-cover-html help
+.DEFAULT_GOAL := help
 
-all: gitinfo
+vendor: ## Install govendor and sync Hugo's vendored dependencies
+       go get github.com/kardianos/govendor
+       govendor sync ${PACKAGE}
 
-install: install-gitinfo
+hugo: vendor ## Build hugo binary
+       go build ${LDFLAGS} ${PACKAGE}
 
-help:
-       echo ${COMMIT_HASH}
-       echo ${BUILD_DATE}
-
-gitinfo:
-       go build ${LDFLAGS} -o hugo main.go
+hugo-race: vendor ## Build hugo binary with race detector enabled
+       go build -race ${LDFLAGS} ${PACAGE}
 
-install-gitinfo:
-       go install ${LDFLAGS} ./...
+install: vendor ## Install hugo binary
+       go install ${LDFLAGS} ${PACKAGE}
 
-no-git-info:
-       go build -o hugo main.go
+hugo-no-gitinfo: LDFLAGS = ${NOGI_LDFLAGS}
+hugo-no-gitinfo: vendor hugo ## Build hugo without git info
 
-docker:
+docker: ## Build hugo Docker container
        docker build -t hugo .
        docker rm -f hugo-build || true
        docker run --name hugo-build hugo ls /go/bin
        docker cp hugo-build:/go/bin/hugo .
        docker rm hugo-build
 
-govendor:
-       go get -u github.com/kardianos/govendor
-       go install github.com/kardianos/govendor
-       govendor sync github.com/spf13/hugo
+govendor: vendor # Deprecated: use "vendor" target
+get: vendor # Deprecated: use "vendor"
+gitinfo: hugo # Deprecated: use "hugo" target
+install-gitinfo: install # Deprecated: use "install" target
+no-git-info: hugo-no-gitinfo # Deprecated: use "hugo-no-gitinfo" target
 
-check: fmt vet test test-race
+check: test-race test386 fmt vet ## Run tests and linters
 
-cyclo:
-       @for d in `govendor list -no-status +local | sed 's/github.com.spf13.hugo/./'` ; do \
-               if [ "`gocyclo -over 20 $$d | tee /dev/stderr`" ]; then \
-                       echo "^ cyclomatic complexity exceeds 20, refactor the code!" && echo && exit 1; \
-               fi \
-       done
+test386: ## Run tests in 32-bit mode
+       GOARCH=386 govendor test +local
+
+test: ## Run tests
+       govendor test +local
+
+test-race: ## Run tests with race detector
+       govendor test -race +local
 
-fmt:
+fmt: ## Run gofmt linter
        @for d in `govendor list -no-status +local | sed 's/github.com.spf13.hugo/./'` ; do \
                if [ "`gofmt -l $$d/*.go | tee /dev/stderr`" ]; then \
                        echo "^ improperly formatted go files" && echo && exit 1; \
                fi \
        done
 
-lint:
+lint: ## Run golint linter
        @for d in `govendor list -no-status +local | sed 's/github.com.spf13.hugo/./'` ; do \
                if [ "`golint $$d | tee /dev/stderr`" ]; then \
                        echo "^ golint errors!" && echo && exit 1; \
                fi \
        done
 
-get:
-       go get -v -t ./...
-
-test:
-       govendor test +local
-
-test-race:
-       govendor test -race +local
-
-vet:
+vet: ## Run go vet linter
        @if [ "`govendor vet +local | tee /dev/stderr`" ]; then \
                echo "^ go vet errors!" && echo && exit 1; \
        fi
 
-test-cover-html:
+test-cover-html: PACKAGES = $(shell govendor list -no-status +local | sed 's/github.com.spf13.hugo/./')
+test-cover-html: ## Generate test coverage report
        echo "mode: count" > coverage-all.out
        $(foreach pkg,$(PACKAGES),\
                govendor test -coverprofile=coverage.out -covermode=count $(pkg);\
                tail -n +2 coverage.out >> coverage-all.out;)
-       go tool cover -html=coverage-all.out
\ No newline at end of file
+       go tool cover -html=coverage-all.out
+
+help:
+       @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

diff --git a/appveyor.yml b/appveyor.yml
index 1a110265fe41a41a8a10db9da6aaee32f33d5600..c77eb9f385d1f48682876d0f67490acec90e3807 100644 (file)
--- a/appveyor.yml
+++ b/appveyor.yml
@@ -13,16 +13,10 @@ install:
 
     pip install docutils
 build_script:
-- cmd: make govendor
+- cmd: make vendor
 test_script:
 - cmd: >-
-    make check
-
-    REM Test 64-bit alignment on 32-bit builds
-
-    set "GOARCH=386" & make test & set GOARCH=
-
-    go build -race
+    make hugo-race check
 
     hugo -s docs/