Makefile 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. GO=$(shell which go)
  2. VERSION := $(shell git describe --tag)
  3. .PHONY:
  4. help:
  5. @echo "Typical commands:"
  6. @echo " make check - Run all tests, vetting/formatting checks and linters"
  7. @echo " make fmt build-snapshot install - Build latest and install to local system"
  8. @echo
  9. @echo "Test/check:"
  10. @echo " make test - Run tests"
  11. @echo " make race - Run tests with -race flag"
  12. @echo " make coverage - Run tests and show coverage"
  13. @echo " make coverage-html - Run tests and show coverage (as HTML)"
  14. @echo " make coverage-upload - Upload coverage results to codecov.io"
  15. @echo
  16. @echo "Lint/format:"
  17. @echo " make fmt - Run 'go fmt'"
  18. @echo " make fmt-check - Run 'go fmt', but don't change anything"
  19. @echo " make vet - Run 'go vet'"
  20. @echo " make lint - Run 'golint'"
  21. @echo " make staticcheck - Run 'staticcheck'"
  22. @echo
  23. @echo "Build:"
  24. @echo " make build - Build"
  25. @echo " make build-snapshot - Build snapshot"
  26. @echo " make build-simple - Build (using go build, without goreleaser)"
  27. @echo " make clean - Clean build folder"
  28. @echo
  29. @echo "Releasing (requires goreleaser):"
  30. @echo " make release - Create a release"
  31. @echo " make release-snapshot - Create a test release"
  32. @echo
  33. @echo "Install locally (requires sudo):"
  34. @echo " make install - Copy binary from dist/ to /usr/bin"
  35. @echo " make install-deb - Install .deb from dist/"
  36. @echo " make install-lint - Install golint"
  37. # Test/check targets
  38. check: test fmt-check vet lint staticcheck
  39. test: .PHONY
  40. $(GO) test ./...
  41. race: .PHONY
  42. $(GO) test -race ./...
  43. coverage:
  44. mkdir -p build/coverage
  45. $(GO) test -race -coverprofile=build/coverage/coverage.txt -covermode=atomic ./...
  46. $(GO) tool cover -func build/coverage/coverage.txt
  47. coverage-html:
  48. mkdir -p build/coverage
  49. $(GO) test -race -coverprofile=build/coverage/coverage.txt -covermode=atomic ./...
  50. $(GO) tool cover -html build/coverage/coverage.txt
  51. coverage-upload:
  52. cd build/coverage && (curl -s https://codecov.io/bash | bash)
  53. # Lint/formatting targets
  54. fmt:
  55. $(GO) fmt ./...
  56. fmt-check:
  57. test -z $(shell gofmt -l .)
  58. vet:
  59. $(GO) vet ./...
  60. lint:
  61. which golint || $(GO) get -u golang.org/x/lint/golint
  62. $(GO) list ./... | grep -v /vendor/ | xargs -L1 golint -set_exit_status
  63. staticcheck: .PHONY
  64. rm -rf build/staticcheck
  65. which staticcheck || go get honnef.co/go/tools/cmd/staticcheck
  66. mkdir -p build/staticcheck
  67. ln -s "$(GO)" build/staticcheck/go
  68. PATH="$(PWD)/build/staticcheck:$(PATH)" staticcheck ./...
  69. rm -rf build/staticcheck
  70. # Building targets
  71. build: .PHONY
  72. goreleaser build --rm-dist
  73. build-snapshot:
  74. goreleaser build --snapshot --rm-dist
  75. build-simple: clean
  76. mkdir -p dist/ntfy_linux_amd64
  77. $(GO) build \
  78. -o dist/ntfy_linux_amd64/ntfy \
  79. -ldflags \
  80. "-s -w -X main.version=$(VERSION) -X main.commit=$(shell git rev-parse --short HEAD) -X main.date=$(shell date +%s)"
  81. clean: .PHONY
  82. rm -rf dist build
  83. # Releasing targets
  84. release:
  85. goreleaser release --rm-dist
  86. release-snapshot:
  87. goreleaser release --snapshot --skip-publish --rm-dist
  88. # Installing targets
  89. install:
  90. sudo rm -f /usr/bin/ntfy
  91. sudo cp -a dist/ntfy_linux_amd64/ntfy /usr/bin/ntfy
  92. install-deb:
  93. sudo systemctl stop ntfy || true
  94. sudo apt-get purge ntfy || true
  95. sudo dpkg -i dist/*.deb