mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-21 14:44:00 +00:00
516 lines
16 KiB
Makefile
516 lines
16 KiB
Makefile
PKG_PREFIX := github.com/VictoriaMetrics/VictoriaMetrics
|
|
|
|
DATEINFO_TAG ?= $(shell date -u +'%Y%m%d-%H%M%S')
|
|
BUILDINFO_TAG ?= $(shell echo $$(git describe --long --all | tr '/' '-')$$( \
|
|
git diff-index --quiet HEAD -- || echo '-dirty-'$$(git diff-index -u HEAD | openssl sha1 | cut -d' ' -f2 | cut -c 1-8)))
|
|
LATEST_TAG ?= latest
|
|
|
|
PKG_TAG ?= $(shell git tag -l --points-at HEAD)
|
|
ifeq ($(PKG_TAG),)
|
|
PKG_TAG := $(BUILDINFO_TAG)
|
|
endif
|
|
|
|
GO_BUILDINFO = -X '$(PKG_PREFIX)/lib/buildinfo.Version=$(APP_NAME)-$(DATEINFO_TAG)-$(BUILDINFO_TAG)'
|
|
|
|
.PHONY: $(MAKECMDGOALS)
|
|
|
|
include app/*/Makefile
|
|
include deployment/*/Makefile
|
|
include snap/local/Makefile
|
|
include package/release/Makefile
|
|
|
|
all: \
|
|
victoria-metrics-prod \
|
|
victoria-logs-prod \
|
|
vmagent-prod \
|
|
vmalert-prod \
|
|
vmauth-prod \
|
|
vmbackup-prod \
|
|
vmrestore-prod \
|
|
vmctl-prod
|
|
|
|
clean:
|
|
rm -rf bin/*
|
|
|
|
publish: package-base \
|
|
publish-victoria-metrics \
|
|
publish-victoria-logs \
|
|
publish-vmagent \
|
|
publish-vmalert \
|
|
publish-vmauth \
|
|
publish-vmbackup \
|
|
publish-vmrestore \
|
|
publish-vmctl
|
|
|
|
package: \
|
|
package-victoria-metrics \
|
|
package-victoria-logs \
|
|
package-vmagent \
|
|
package-vmalert \
|
|
package-vmauth \
|
|
package-vmbackup \
|
|
package-vmrestore \
|
|
package-vmctl
|
|
|
|
vmutils: \
|
|
vmagent \
|
|
vmalert \
|
|
vmauth \
|
|
vmbackup \
|
|
vmrestore \
|
|
vmctl
|
|
|
|
vmutils-pure: \
|
|
vmagent-pure \
|
|
vmalert-pure \
|
|
vmauth-pure \
|
|
vmbackup-pure \
|
|
vmrestore-pure \
|
|
vmctl-pure
|
|
|
|
vmutils-linux-amd64: \
|
|
vmagent-linux-amd64 \
|
|
vmalert-linux-amd64 \
|
|
vmauth-linux-amd64 \
|
|
vmbackup-linux-amd64 \
|
|
vmrestore-linux-amd64 \
|
|
vmctl-linux-amd64
|
|
|
|
vmutils-linux-arm64: \
|
|
vmagent-linux-arm64 \
|
|
vmalert-linux-arm64 \
|
|
vmauth-linux-arm64 \
|
|
vmbackup-linux-arm64 \
|
|
vmrestore-linux-arm64 \
|
|
vmctl-linux-arm64
|
|
|
|
vmutils-linux-arm: \
|
|
vmagent-linux-arm \
|
|
vmalert-linux-arm \
|
|
vmauth-linux-arm \
|
|
vmbackup-linux-arm \
|
|
vmrestore-linux-arm \
|
|
vmctl-linux-arm
|
|
|
|
vmutils-linux-386: \
|
|
vmagent-linux-386 \
|
|
vmalert-linux-386 \
|
|
vmauth-linux-386 \
|
|
vmbackup-linux-386 \
|
|
vmrestore-linux-386 \
|
|
vmctl-linux-386
|
|
|
|
vmutils-linux-ppc64le: \
|
|
vmagent-linux-ppc64le \
|
|
vmalert-linux-ppc64le \
|
|
vmauth-linux-ppc64le \
|
|
vmbackup-linux-ppc64le \
|
|
vmrestore-linux-ppc64le \
|
|
vmctl-linux-ppc64le
|
|
|
|
vmutils-darwin-amd64: \
|
|
vmagent-darwin-amd64 \
|
|
vmalert-darwin-amd64 \
|
|
vmauth-darwin-amd64 \
|
|
vmbackup-darwin-amd64 \
|
|
vmrestore-darwin-amd64 \
|
|
vmctl-darwin-amd64
|
|
|
|
vmutils-darwin-arm64: \
|
|
vmagent-darwin-arm64 \
|
|
vmalert-darwin-arm64 \
|
|
vmauth-darwin-arm64 \
|
|
vmbackup-darwin-arm64 \
|
|
vmrestore-darwin-arm64 \
|
|
vmctl-darwin-arm64
|
|
|
|
vmutils-freebsd-amd64: \
|
|
vmagent-freebsd-amd64 \
|
|
vmalert-freebsd-amd64 \
|
|
vmauth-freebsd-amd64 \
|
|
vmbackup-freebsd-amd64 \
|
|
vmrestore-freebsd-amd64 \
|
|
vmctl-freebsd-amd64
|
|
|
|
vmutils-openbsd-amd64: \
|
|
vmagent-openbsd-amd64 \
|
|
vmalert-openbsd-amd64 \
|
|
vmauth-openbsd-amd64 \
|
|
vmbackup-openbsd-amd64 \
|
|
vmrestore-openbsd-amd64 \
|
|
vmctl-openbsd-amd64
|
|
|
|
vmutils-windows-amd64: \
|
|
vmagent-windows-amd64 \
|
|
vmalert-windows-amd64 \
|
|
vmauth-windows-amd64 \
|
|
vmbackup-windows-amd64 \
|
|
vmrestore-windows-amd64 \
|
|
vmctl-windows-amd64
|
|
|
|
victoria-metrics-crossbuild: \
|
|
victoria-metrics-linux-386 \
|
|
victoria-metrics-linux-amd64 \
|
|
victoria-metrics-linux-arm64 \
|
|
victoria-metrics-linux-arm \
|
|
victoria-metrics-linux-386 \
|
|
victoria-metrics-linux-ppc64le \
|
|
victoria-metrics-darwin-amd64 \
|
|
victoria-metrics-darwin-arm64 \
|
|
victoria-metrics-freebsd-amd64 \
|
|
victoria-metrics-openbsd-amd64
|
|
|
|
vmutils-crossbuild: \
|
|
vmutils-linux-386 \
|
|
vmutils-linux-amd64 \
|
|
vmutils-linux-arm64 \
|
|
vmutils-linux-arm \
|
|
vmutils-linux-386 \
|
|
vmutils-linux-ppc64le \
|
|
vmutils-darwin-amd64 \
|
|
vmutils-darwin-arm64 \
|
|
vmutils-freebsd-amd64 \
|
|
vmutils-openbsd-amd64 \
|
|
vmutils-windows-amd64
|
|
|
|
publish-release:
|
|
git checkout $(TAG) && LATEST_TAG=stable $(MAKE) release publish && \
|
|
git checkout $(TAG)-cluster && LATEST_TAG=cluster-stable $(MAKE) release publish && \
|
|
git checkout $(TAG)-enterprise && LATEST_TAG=enterprise-stable $(MAKE) release publish && \
|
|
git checkout $(TAG)-enterprise-cluster && LATEST_TAG=enterprise-cluster-stable $(MAKE) release publish
|
|
|
|
release: \
|
|
release-victoria-metrics \
|
|
release-victoria-logs \
|
|
release-vmutils
|
|
|
|
release-victoria-metrics: \
|
|
release-victoria-metrics-linux-386 \
|
|
release-victoria-metrics-linux-amd64 \
|
|
release-victoria-metrics-linux-arm \
|
|
release-victoria-metrics-linux-arm64 \
|
|
release-victoria-metrics-darwin-amd64 \
|
|
release-victoria-metrics-darwin-arm64 \
|
|
release-victoria-metrics-freebsd-amd64 \
|
|
release-victoria-metrics-openbsd-amd64 \
|
|
release-victoria-metrics-windows-amd64
|
|
|
|
release-victoria-metrics-linux-386:
|
|
GOOS=linux GOARCH=386 $(MAKE) release-victoria-metrics-goos-goarch
|
|
|
|
release-victoria-metrics-linux-amd64:
|
|
GOOS=linux GOARCH=amd64 $(MAKE) release-victoria-metrics-goos-goarch
|
|
|
|
release-victoria-metrics-linux-arm:
|
|
GOOS=linux GOARCH=arm $(MAKE) release-victoria-metrics-goos-goarch
|
|
|
|
release-victoria-metrics-linux-arm64:
|
|
GOOS=linux GOARCH=arm64 $(MAKE) release-victoria-metrics-goos-goarch
|
|
|
|
release-victoria-metrics-darwin-amd64:
|
|
GOOS=darwin GOARCH=amd64 $(MAKE) release-victoria-metrics-goos-goarch
|
|
|
|
release-victoria-metrics-darwin-arm64:
|
|
GOOS=darwin GOARCH=arm64 $(MAKE) release-victoria-metrics-goos-goarch
|
|
|
|
release-victoria-metrics-freebsd-amd64:
|
|
GOOS=freebsd GOARCH=amd64 $(MAKE) release-victoria-metrics-goos-goarch
|
|
|
|
release-victoria-metrics-openbsd-amd64:
|
|
GOOS=openbsd GOARCH=amd64 $(MAKE) release-victoria-metrics-goos-goarch
|
|
|
|
release-victoria-metrics-windows-amd64:
|
|
GOARCH=amd64 $(MAKE) release-victoria-metrics-windows-goarch
|
|
|
|
release-victoria-metrics-goos-goarch: victoria-metrics-$(GOOS)-$(GOARCH)-prod
|
|
cd bin && \
|
|
tar --transform="flags=r;s|-$(GOOS)-$(GOARCH)||" -czf victoria-metrics-$(GOOS)-$(GOARCH)-$(PKG_TAG).tar.gz \
|
|
victoria-metrics-$(GOOS)-$(GOARCH)-prod \
|
|
&& sha256sum victoria-metrics-$(GOOS)-$(GOARCH)-$(PKG_TAG).tar.gz \
|
|
victoria-metrics-$(GOOS)-$(GOARCH)-prod \
|
|
| sed s/-$(GOOS)-$(GOARCH)-prod/-prod/ > victoria-metrics-$(GOOS)-$(GOARCH)-$(PKG_TAG)_checksums.txt
|
|
cd bin && rm -rf victoria-metrics-$(GOOS)-$(GOARCH)-prod
|
|
|
|
release-victoria-metrics-windows-goarch: victoria-metrics-windows-$(GOARCH)-prod
|
|
cd bin && \
|
|
zip victoria-metrics-windows-$(GOARCH)-$(PKG_TAG).zip \
|
|
victoria-metrics-windows-$(GOARCH)-prod.exe \
|
|
&& sha256sum victoria-metrics-windows-$(GOARCH)-$(PKG_TAG).zip \
|
|
victoria-metrics-windows-$(GOARCH)-prod.exe \
|
|
> victoria-metrics-windows-$(GOARCH)-$(PKG_TAG)_checksums.txt
|
|
cd bin && rm -rf \
|
|
victoria-metrics-windows-$(GOARCH)-prod.exe
|
|
|
|
release-victoria-logs: \
|
|
release-victoria-logs-linux-386 \
|
|
release-victoria-logs-linux-amd64 \
|
|
release-victoria-logs-linux-arm \
|
|
release-victoria-logs-linux-arm64 \
|
|
release-victoria-logs-darwin-amd64 \
|
|
release-victoria-logs-darwin-arm64 \
|
|
release-victoria-logs-freebsd-amd64 \
|
|
release-victoria-logs-openbsd-amd64 \
|
|
release-victoria-logs-windows-amd64
|
|
|
|
release-victoria-logs-linux-386:
|
|
GOOS=linux GOARCH=386 $(MAKE) release-victoria-logs-goos-goarch
|
|
|
|
release-victoria-logs-linux-amd64:
|
|
GOOS=linux GOARCH=amd64 $(MAKE) release-victoria-logs-goos-goarch
|
|
|
|
release-victoria-logs-linux-arm:
|
|
GOOS=linux GOARCH=arm $(MAKE) release-victoria-logs-goos-goarch
|
|
|
|
release-victoria-logs-linux-arm64:
|
|
GOOS=linux GOARCH=arm64 $(MAKE) release-victoria-logs-goos-goarch
|
|
|
|
release-victoria-logs-darwin-amd64:
|
|
GOOS=darwin GOARCH=amd64 $(MAKE) release-victoria-logs-goos-goarch
|
|
|
|
release-victoria-logs-darwin-arm64:
|
|
GOOS=darwin GOARCH=arm64 $(MAKE) release-victoria-logs-goos-goarch
|
|
|
|
release-victoria-logs-freebsd-amd64:
|
|
GOOS=freebsd GOARCH=amd64 $(MAKE) release-victoria-logs-goos-goarch
|
|
|
|
release-victoria-logs-openbsd-amd64:
|
|
GOOS=openbsd GOARCH=amd64 $(MAKE) release-victoria-logs-goos-goarch
|
|
|
|
release-victoria-logs-windows-amd64:
|
|
GOARCH=amd64 $(MAKE) release-victoria-logs-windows-goarch
|
|
|
|
release-victoria-logs-goos-goarch: victoria-logs-$(GOOS)-$(GOARCH)-prod
|
|
cd bin && \
|
|
tar --transform="flags=r;s|-$(GOOS)-$(GOARCH)||" -czf victoria-logs-$(GOOS)-$(GOARCH)-$(PKG_TAG).tar.gz \
|
|
victoria-logs-$(GOOS)-$(GOARCH)-prod \
|
|
&& sha256sum victoria-logs-$(GOOS)-$(GOARCH)-$(PKG_TAG).tar.gz \
|
|
victoria-logs-$(GOOS)-$(GOARCH)-prod \
|
|
| sed s/-$(GOOS)-$(GOARCH)-prod/-prod/ > victoria-logs-$(GOOS)-$(GOARCH)-$(PKG_TAG)_checksums.txt
|
|
cd bin && rm -rf victoria-logs-$(GOOS)-$(GOARCH)-prod
|
|
|
|
release-victoria-logs-windows-goarch: victoria-logs-windows-$(GOARCH)-prod
|
|
cd bin && \
|
|
zip victoria-logs-windows-$(GOARCH)-$(PKG_TAG).zip \
|
|
victoria-logs-windows-$(GOARCH)-prod.exe \
|
|
&& sha256sum victoria-logs-windows-$(GOARCH)-$(PKG_TAG).zip \
|
|
victoria-logs-windows-$(GOARCH)-prod.exe \
|
|
> victoria-logs-windows-$(GOARCH)-$(PKG_TAG)_checksums.txt
|
|
cd bin && rm -rf \
|
|
victoria-logs-windows-$(GOARCH)-prod.exe
|
|
|
|
release-vmutils: \
|
|
release-vmutils-linux-386 \
|
|
release-vmutils-linux-amd64 \
|
|
release-vmutils-linux-arm64 \
|
|
release-vmutils-linux-arm \
|
|
release-vmutils-darwin-amd64 \
|
|
release-vmutils-darwin-arm64 \
|
|
release-vmutils-freebsd-amd64 \
|
|
release-vmutils-openbsd-amd64 \
|
|
release-vmutils-windows-amd64
|
|
|
|
release-vmutils-linux-386:
|
|
GOOS=linux GOARCH=386 $(MAKE) release-vmutils-goos-goarch
|
|
|
|
release-vmutils-linux-amd64:
|
|
GOOS=linux GOARCH=amd64 $(MAKE) release-vmutils-goos-goarch
|
|
|
|
release-vmutils-linux-arm64:
|
|
GOOS=linux GOARCH=arm64 $(MAKE) release-vmutils-goos-goarch
|
|
|
|
release-vmutils-linux-arm:
|
|
GOOS=linux GOARCH=arm $(MAKE) release-vmutils-goos-goarch
|
|
|
|
release-vmutils-darwin-amd64:
|
|
GOOS=darwin GOARCH=amd64 $(MAKE) release-vmutils-goos-goarch
|
|
|
|
release-vmutils-darwin-arm64:
|
|
GOOS=darwin GOARCH=arm64 $(MAKE) release-vmutils-goos-goarch
|
|
|
|
release-vmutils-freebsd-amd64:
|
|
GOOS=freebsd GOARCH=amd64 $(MAKE) release-vmutils-goos-goarch
|
|
|
|
release-vmutils-openbsd-amd64:
|
|
GOOS=openbsd GOARCH=amd64 $(MAKE) release-vmutils-goos-goarch
|
|
|
|
release-vmutils-windows-amd64:
|
|
GOARCH=amd64 $(MAKE) release-vmutils-windows-goarch
|
|
|
|
release-vmutils-goos-goarch: \
|
|
vmagent-$(GOOS)-$(GOARCH)-prod \
|
|
vmalert-$(GOOS)-$(GOARCH)-prod \
|
|
vmauth-$(GOOS)-$(GOARCH)-prod \
|
|
vmbackup-$(GOOS)-$(GOARCH)-prod \
|
|
vmrestore-$(GOOS)-$(GOARCH)-prod \
|
|
vmctl-$(GOOS)-$(GOARCH)-prod
|
|
cd bin && \
|
|
tar --transform="flags=r;s|-$(GOOS)-$(GOARCH)||" -czf vmutils-$(GOOS)-$(GOARCH)-$(PKG_TAG).tar.gz \
|
|
vmagent-$(GOOS)-$(GOARCH)-prod \
|
|
vmalert-$(GOOS)-$(GOARCH)-prod \
|
|
vmauth-$(GOOS)-$(GOARCH)-prod \
|
|
vmbackup-$(GOOS)-$(GOARCH)-prod \
|
|
vmrestore-$(GOOS)-$(GOARCH)-prod \
|
|
vmctl-$(GOOS)-$(GOARCH)-prod \
|
|
&& sha256sum vmutils-$(GOOS)-$(GOARCH)-$(PKG_TAG).tar.gz \
|
|
vmagent-$(GOOS)-$(GOARCH)-prod \
|
|
vmalert-$(GOOS)-$(GOARCH)-prod \
|
|
vmauth-$(GOOS)-$(GOARCH)-prod \
|
|
vmbackup-$(GOOS)-$(GOARCH)-prod \
|
|
vmrestore-$(GOOS)-$(GOARCH)-prod \
|
|
vmctl-$(GOOS)-$(GOARCH)-prod \
|
|
| sed s/-$(GOOS)-$(GOARCH)-prod/-prod/ > vmutils-$(GOOS)-$(GOARCH)-$(PKG_TAG)_checksums.txt
|
|
cd bin && rm -rf \
|
|
vmagent-$(GOOS)-$(GOARCH)-prod \
|
|
vmalert-$(GOOS)-$(GOARCH)-prod \
|
|
vmauth-$(GOOS)-$(GOARCH)-prod \
|
|
vmbackup-$(GOOS)-$(GOARCH)-prod \
|
|
vmrestore-$(GOOS)-$(GOARCH)-prod \
|
|
vmctl-$(GOOS)-$(GOARCH)-prod
|
|
|
|
release-vmutils-windows-goarch: \
|
|
vmagent-windows-$(GOARCH)-prod \
|
|
vmalert-windows-$(GOARCH)-prod \
|
|
vmauth-windows-$(GOARCH)-prod \
|
|
vmbackup-windows-$(GOARCH)-prod \
|
|
vmrestore-windows-$(GOARCH)-prod \
|
|
vmctl-windows-$(GOARCH)-prod
|
|
cd bin && \
|
|
zip vmutils-windows-$(GOARCH)-$(PKG_TAG).zip \
|
|
vmagent-windows-$(GOARCH)-prod.exe \
|
|
vmalert-windows-$(GOARCH)-prod.exe \
|
|
vmauth-windows-$(GOARCH)-prod.exe \
|
|
vmbackup-windows-$(GOARCH)-prod.exe \
|
|
vmrestore-windows-$(GOARCH)-prod.exe \
|
|
vmctl-windows-$(GOARCH)-prod.exe \
|
|
&& sha256sum vmutils-windows-$(GOARCH)-$(PKG_TAG).zip \
|
|
vmagent-windows-$(GOARCH)-prod.exe \
|
|
vmalert-windows-$(GOARCH)-prod.exe \
|
|
vmauth-windows-$(GOARCH)-prod.exe \
|
|
vmbackup-windows-$(GOARCH)-prod.exe \
|
|
vmrestore-windows-$(GOARCH)-prod.exe \
|
|
vmctl-windows-$(GOARCH)-prod.exe \
|
|
> vmutils-windows-$(GOARCH)-$(PKG_TAG)_checksums.txt
|
|
cd bin && rm -rf \
|
|
vmagent-windows-$(GOARCH)-prod.exe \
|
|
vmalert-windows-$(GOARCH)-prod.exe \
|
|
vmauth-windows-$(GOARCH)-prod.exe \
|
|
vmbackup-windows-$(GOARCH)-prod.exe \
|
|
vmrestore-windows-$(GOARCH)-prod.exe \
|
|
vmctl-windows-$(GOARCH)-prod.exe
|
|
|
|
pprof-cpu:
|
|
go tool pprof -trim_path=github.com/VictoriaMetrics/VictoriaMetrics@ $(PPROF_FILE)
|
|
|
|
fmt:
|
|
gofmt -l -w -s ./lib
|
|
gofmt -l -w -s ./app
|
|
|
|
vet:
|
|
go vet ./lib/...
|
|
go vet ./app/...
|
|
|
|
check-all: fmt vet golangci-lint govulncheck
|
|
|
|
test:
|
|
go test ./lib/... ./app/...
|
|
|
|
test-race:
|
|
go test -race ./lib/... ./app/...
|
|
|
|
test-pure:
|
|
CGO_ENABLED=0 go test ./lib/... ./app/...
|
|
|
|
test-full:
|
|
go test -coverprofile=coverage.txt -covermode=atomic ./lib/... ./app/...
|
|
|
|
test-full-386:
|
|
GOARCH=386 go test -coverprofile=coverage.txt -covermode=atomic ./lib/... ./app/...
|
|
|
|
benchmark:
|
|
go test -bench=. ./lib/...
|
|
go test -bench=. ./app/...
|
|
|
|
benchmark-pure:
|
|
CGO_ENABLED=0 go test -bench=. ./lib/...
|
|
CGO_ENABLED=0 go test -bench=. ./app/...
|
|
|
|
vendor-update:
|
|
go get -u -d ./lib/...
|
|
go get -u -d ./app/...
|
|
go mod tidy -compat=1.19
|
|
go mod vendor
|
|
|
|
app-local:
|
|
CGO_ENABLED=1 go build $(RACE) -ldflags "$(GO_BUILDINFO)" -o bin/$(APP_NAME)$(RACE) $(PKG_PREFIX)/app/$(APP_NAME)
|
|
|
|
app-local-pure:
|
|
CGO_ENABLED=0 go build $(RACE) -ldflags "$(GO_BUILDINFO)" -o bin/$(APP_NAME)-pure$(RACE) $(PKG_PREFIX)/app/$(APP_NAME)
|
|
|
|
app-local-goos-goarch:
|
|
CGO_ENABLED=$(CGO_ENABLED) GOOS=$(GOOS) GOARCH=$(GOARCH) go build $(RACE) -ldflags "$(GO_BUILDINFO)" -o bin/$(APP_NAME)-$(GOOS)-$(GOARCH)$(RACE) $(PKG_PREFIX)/app/$(APP_NAME)
|
|
|
|
app-local-windows-goarch:
|
|
CGO_ENABLED=0 GOOS=windows GOARCH=$(GOARCH) go build $(RACE) -ldflags "$(GO_BUILDINFO)" -o bin/$(APP_NAME)-windows-$(GOARCH)$(RACE).exe $(PKG_PREFIX)/app/$(APP_NAME)
|
|
|
|
quicktemplate-gen: install-qtc
|
|
qtc
|
|
|
|
install-qtc:
|
|
which qtc || go install github.com/valyala/quicktemplate/qtc@latest
|
|
|
|
|
|
golangci-lint: install-golangci-lint
|
|
golangci-lint run
|
|
|
|
install-golangci-lint:
|
|
which golangci-lint || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin v1.54.2
|
|
|
|
govulncheck: install-govulncheck
|
|
govulncheck ./...
|
|
|
|
install-govulncheck:
|
|
which govulncheck || go install golang.org/x/vuln/cmd/govulncheck@latest
|
|
|
|
install-wwhrd:
|
|
which wwhrd || go install github.com/frapposelli/wwhrd@latest
|
|
|
|
check-licenses: install-wwhrd
|
|
wwhrd check -f .wwhrd.yml
|
|
|
|
copy-docs:
|
|
# The 'printf' function is used instead of 'echo' or 'echo -e' to handle line breaks (e.g. '\n') in the same way on different operating systems (MacOS/Ubuntu Linux/Arch Linux) and their shells (bash/sh/zsh/fish).
|
|
# For details, see https://github.com/VictoriaMetrics/VictoriaMetrics/pull/4548#issue-1782796419 and https://stackoverflow.com/questions/8467424/echo-newline-in-bash-prints-literal-n
|
|
echo "---" > ${DST}
|
|
@if [ ${ORDER} -ne 0 ]; then \
|
|
echo "sort: ${ORDER}" >> ${DST}; \
|
|
echo "weight: ${ORDER}" >> ${DST}; \
|
|
printf "menu:\n docs:\n parent: 'victoriametrics'\n weight: ${ORDER}\n" >> ${DST}; \
|
|
fi
|
|
|
|
echo "title: ${TITLE}" >> ${DST}
|
|
@if [ ${OLD_URL} ]; then \
|
|
printf "aliases:\n - ${OLD_URL}\n" >> ${DST}; \
|
|
fi
|
|
echo "---" >> ${DST}
|
|
cat ${SRC} >> ${DST}
|
|
sed -i='.tmp' 's/<img src=\"docs\//<img src=\"/' ${DST}
|
|
rm -rf docs/*.tmp
|
|
|
|
# Copies docs for all components and adds the order/weight tag, title, menu position and alias with the backward compatible link for the old site.
|
|
# For ORDER=0 it adds no order tag/weight tag.
|
|
# FOR OLD_URL - relative link, used for backward compatibility with the link from documentation based on GitHub pages (old one)
|
|
# FOR OLD_URL='' it adds no alias, it should be empty for every new page, don't change it for already existing links.
|
|
# Images starting with <img src="docs/ are replaced with <img src="
|
|
# Cluster docs are supposed to be ordered as 2nd.
|
|
# The rest of docs is ordered manually.
|
|
docs-sync:
|
|
SRC=README.md DST=docs/README.md OLD_URL='' ORDER=0 TITLE=VictoriaMetrics $(MAKE) copy-docs
|
|
SRC=README.md DST=docs/Single-server-VictoriaMetrics.md OLD_URL='/Single-server-VictoriaMetrics.html' TITLE=VictoriaMetrics ORDER=1 $(MAKE) copy-docs
|
|
SRC=app/vmagent/README.md DST=docs/vmagent.md OLD_URL='/vmagent.html' ORDER=3 TITLE=vmagent $(MAKE) copy-docs
|
|
SRC=app/vmalert/README.md DST=docs/vmalert.md OLD_URL='/vmalert.html' ORDER=4 TITLE=vmalert $(MAKE) copy-docs
|
|
SRC=app/vmauth/README.md DST=docs/vmauth.md OLD_URL='/vmauth.html' ORDER=5 TITLE=vmauth $(MAKE) copy-docs
|
|
SRC=app/vmbackup/README.md DST=docs/vmbackup.md OLD_URL='/vmbackup.html' ORDER=6 TITLE=vmbackup $(MAKE) copy-docs
|
|
SRC=app/vmrestore/README.md DST=docs/vmrestore.md OLD_URL='/vmrestore.html' ORDER=7 TITLE=vmrestore $(MAKE) copy-docs
|
|
SRC=app/vmctl/README.md DST=docs/vmctl.md OLD_URL='/vmctl.html' ORDER=8 TITLE=vmctl $(MAKE) copy-docs
|
|
SRC=app/vmgateway/README.md DST=docs/vmgateway.md OLD_URL='/vmgateway.html' ORDER=9 TITLE=vmgateway $(MAKE) copy-docs
|
|
SRC=app/vmbackupmanager/README.md DST=docs/vmbackupmanager.md OLD_URL='/vmbackupmanager.html' ORDER=10 TITLE=vmbackupmanager $(MAKE) copy-docs
|