github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity
VictoriaMetrics/Makefile

425 lines
12 KiB
Makefile
Raw Normal View History

all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
PKG_PREFIX := github.com/VictoriaMetrics/VictoriaMetrics
Allow specifying build date from a variable (#1200) Just like the existing infrastructure for `BUILDINFO_TAG`, this can ease the production of [reproducible builds](https://wiki.freebsd.org/ReproducibleBuilds). (e.g. in FreeBSD the date the port was committed is used at build time, not the actual build time, so that an identical port produced at different times produces an identical executable)
2021-04-10 12:46:53 +00:00
DATEINFO_TAG ?= $(shell date -u +'%Y%m%d-%H%M%S')
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
BUILDINFO_TAG ?= $(shell echo $$(git describe --long --all | tr '/' '-')$$( \
all: port to FreeBSD on GOARCH=amd64
2019-08-27 22:04:44 +00:00
git diff-index --quiet HEAD -- || echo '-dirty-'$$(git diff-index -u HEAD | openssl sha1 | cut -c 10-17)))
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
PKG_TAG ?= $(shell git tag -l --points-at HEAD)
ifeq ($(PKG_TAG),)
PKG_TAG := $(BUILDINFO_TAG)
endif
Allow specifying build date from a variable (#1200) Just like the existing infrastructure for `BUILDINFO_TAG`, this can ease the production of [reproducible builds](https://wiki.freebsd.org/ReproducibleBuilds). (e.g. in FreeBSD the date the port was committed is used at build time, not the actual build time, so that an identical port produced at different times produces an identical executable)
2021-04-10 12:46:53 +00:00
GO_BUILDINFO = -X '$(PKG_PREFIX)/lib/buildinfo.Version=$(APP_NAME)-$(DATEINFO_TAG)-$(BUILDINFO_TAG)'
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
Makefile: force running Makefile rules if there is a file matching their names
2020-12-18 10:20:01 +00:00
.PHONY: $(MAKECMDGOALS)
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
include app/*/Makefile
include deployment/*/Makefile
include snap/local/Makefile
simplify release process (#3012) * simplify release process * address comments * address comments * wip * wip * wip Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-08-30 23:27:24 +00:00
include package/release/Makefile
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
all: \
app/vmagent: initial implementation for vmagent
2020-02-23 11:35:47 +00:00
victoria-metrics-prod \
vmagent-prod \
app/vmauth: add initial version of vmauth. See https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/app/vmauth/README.md for details
2020-05-05 07:53:42 +00:00
vmalert-prod \
vmauth-prod \
app/vmagent: initial implementation for vmagent
2020-02-23 11:35:47 +00:00
vmbackup-prod \
app/vmctl: move vmctl code from github.com/VictoriaMetrics/vmctl It is better developing vmctl tool in VictoriaMetrics repository, so it could be released together with the rest of vmutils tools such as vmalert, vmagent, vmbackup, vmrestore and vmauth.
2021-01-31 23:10:16 +00:00
vmrestore-prod \
vmctl-prod
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
clean:
rm -rf bin/*
deployment/docker/Makefile: added docker-scan (#2916) * deployment/docker/Makefile: added docker-scan docker-scan based on native 'docker scan' function that use snyk.io, see https://docs.docker.com/engine/scan/ * set to call 'docker-scan after release binaries but before publishing
2022-08-02 06:54:39 +00:00
publish: docker-scan \
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
publish-victoria-metrics \
app/vmagent: initial implementation for vmagent
2020-02-23 11:35:47 +00:00
publish-vmagent \
app/vmalert: include it into the next release
2020-04-27 21:09:35 +00:00
publish-vmalert \
app/vmauth: add initial version of vmauth. See https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/app/vmauth/README.md for details
2020-05-05 07:53:42 +00:00
publish-vmauth \
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
publish-vmbackup \
app/vmctl: move vmctl code from github.com/VictoriaMetrics/vmctl It is better developing vmctl tool in VictoriaMetrics repository, so it could be released together with the rest of vmutils tools such as vmalert, vmagent, vmbackup, vmrestore and vmauth.
2021-01-31 23:10:16 +00:00
publish-vmrestore \
publish-vmctl
Makefile: add `make publish` and `make package` shortcuts for building and publishing docker images
2019-05-24 10:19:24 +00:00
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
package: \
package-victoria-metrics \
app/vmagent: initial implementation for vmagent
2020-02-23 11:35:47 +00:00
package-vmagent \
app/vmalert: include it into the next release
2020-04-27 21:09:35 +00:00
package-vmalert \
app/vmauth: add initial version of vmauth. See https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/app/vmauth/README.md for details
2020-05-05 07:53:42 +00:00
package-vmauth \
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
package-vmbackup \
app/vmctl: move vmctl code from github.com/VictoriaMetrics/vmctl It is better developing vmctl tool in VictoriaMetrics repository, so it could be released together with the rest of vmutils tools such as vmalert, vmagent, vmbackup, vmrestore and vmauth.
2021-01-31 23:10:16 +00:00
package-vmrestore \
package-vmctl
Makefile: add `make publish` and `make package` shortcuts for building and publishing docker images
2019-05-24 10:19:24 +00:00
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
vmutils: \
app/vmagent: initial implementation for vmagent
2020-02-23 11:35:47 +00:00
vmagent \
app/vmalert: include it into the next release
2020-04-27 21:09:35 +00:00
vmalert \
app/vmauth: add initial version of vmauth. See https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/app/vmauth/README.md for details
2020-05-05 07:53:42 +00:00
vmauth \
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
vmbackup \
app/vmctl: move vmctl code from github.com/VictoriaMetrics/vmctl It is better developing vmctl tool in VictoriaMetrics repository, so it could be released together with the rest of vmutils tools such as vmalert, vmagent, vmbackup, vmrestore and vmauth.
2021-01-31 23:10:16 +00:00
vmrestore \
vmctl
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
Add `vmutils-pure` target (#1163)
2021-03-31 14:42:08 +00:00
vmutils-pure: \
vmagent-pure \
vmalert-pure \
vmauth-pure \
vmbackup-pure \
vmrestore-pure \
vmctl-pure
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
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
Makefile: build vmutils for arm on `make release-vmutils` Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1147
2021-03-29 20:13:00 +00:00
Makefile: prepare vmutils-windows-*.zip archive on `make release-vmutils` command The archive contains the following executables for Windows: * vmagent * vmalert * vmauth * vmctl Other components - vmbackup, vmrestore, victoria-metrics - aren't supported for Windows yet
2021-03-16 18:49:07 +00:00
vmutils-windows-amd64: \
vmagent-windows-amd64 \
vmalert-windows-amd64 \
vmauth-windows-amd64 \
vmctl-windows-amd64
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
victoria-metrics-crossbuild: \
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-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
Snap docs change (#986) * adds snap docs, adds release information for snap package, adds docs notes about configuration management with snap package. * adds release page mention * version fix for snap, its awful * revert version * Apply suggestions from code review Co-authored-by: Aliaksandr Valialkin <valyala@gmail.com>
2020-12-29 09:43:09 +00:00
Makefile: add `TAG=v... make publish-release` rule for building and publishing a release for the given TAG
2021-11-08 10:29:10 +00:00
publish-release:
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
git checkout $(TAG) && $(MAKE) release publish && \
git checkout $(TAG)-cluster && $(MAKE) release publish && \
git checkout $(TAG)-enterprise && $(MAKE) release publish && \
Makefile: remove github-create-release and github-upload-assets commands from `publish-release` This is a follow-up for b9231c715a50741123359c0d6ca59134856181f3
2022-09-08 18:02:11 +00:00
git checkout $(TAG)-enterprise-cluster && $(MAKE) release publish
Makefile: add `TAG=v... make publish-release` rule for building and publishing a release for the given TAG
2021-11-08 10:29:10 +00:00
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
release: \
release-victoria-metrics \
release-vmutils
Makefile: add `release-victoria-metrics-arm64` build rule
2021-01-13 16:13:18 +00:00
release-victoria-metrics: \
Rename release packages (#2810) * makefile: add os to each release file * makefile: update vmutils arm64 * makefile: update victoria-metrics release process * makefile: update publish with os * makefile: update publish with os * makefile: change tar library * update release logic * copy all releases * sort command by GOOS * rollback commands * rollback OSARCH * fix commands * cleanup * fix windows build * sort build by GOOS, update README.md
2022-07-13 12:42:48 +00:00
release-victoria-metrics-linux-amd64 \
release-victoria-metrics-linux-arm \
release-victoria-metrics-linux-arm64 \
adds release build for macos darwin amd64 and arm64 (#2185) * adds release build for macos darwin amd64 and arm64 https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1896 https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1851 * wip Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-02-14 15:28:56 +00:00
release-victoria-metrics-darwin-amd64 \
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
release-victoria-metrics-darwin-arm64 \
release-victoria-metrics-freebsd-amd64 \
release-victoria-metrics-openbsd-amd64
Makefile: add `release-victoria-metrics-arm64` build rule
2021-01-13 16:13:18 +00:00
Rename release packages (#2810) * makefile: add os to each release file * makefile: update vmutils arm64 * makefile: update victoria-metrics release process * makefile: update publish with os * makefile: update publish with os * makefile: change tar library * update release logic * copy all releases * sort command by GOOS * rollback commands * rollback OSARCH * fix commands * cleanup * fix windows build * sort build by GOOS, update README.md
2022-07-13 12:42:48 +00:00
release-victoria-metrics-linux-amd64:
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
GOOS=linux GOARCH=amd64 $(MAKE) release-victoria-metrics-goos-goarch
adds release build for macos darwin amd64 and arm64 (#2185) * adds release build for macos darwin amd64 and arm64 https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1896 https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1851 * wip Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-02-14 15:28:56 +00:00
Rename release packages (#2810) * makefile: add os to each release file * makefile: update vmutils arm64 * makefile: update victoria-metrics release process * makefile: update publish with os * makefile: update publish with os * makefile: change tar library * update release logic * copy all releases * sort command by GOOS * rollback commands * rollback OSARCH * fix commands * cleanup * fix windows build * sort build by GOOS, update README.md
2022-07-13 12:42:48 +00:00
release-victoria-metrics-linux-arm:
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
GOOS=linux GOARCH=arm $(MAKE) release-victoria-metrics-goos-goarch
Rename release packages (#2810) * makefile: add os to each release file * makefile: update vmutils arm64 * makefile: update victoria-metrics release process * makefile: update publish with os * makefile: update publish with os * makefile: change tar library * update release logic * copy all releases * sort command by GOOS * rollback commands * rollback OSARCH * fix commands * cleanup * fix windows build * sort build by GOOS, update README.md
2022-07-13 12:42:48 +00:00
release-victoria-metrics-linux-arm64:
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
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
Rename release packages (#2810) * makefile: add os to each release file * makefile: update vmutils arm64 * makefile: update victoria-metrics release process * makefile: update publish with os * makefile: update publish with os * makefile: change tar library * update release logic * copy all releases * sort command by GOOS * rollback commands * rollback OSARCH * fix commands * cleanup * fix windows build * sort build by GOOS, update README.md
2022-07-13 12:42:48 +00:00
adds release build for macos darwin amd64 and arm64 (#2185) * adds release build for macos darwin amd64 and arm64 https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1896 https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1851 * wip Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-02-14 15:28:56 +00:00
release-victoria-metrics-darwin-arm64:
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
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
adds release build for macos darwin amd64 and arm64 (#2185) * adds release build for macos darwin amd64 and arm64 https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1896 https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1851 * wip Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-02-14 15:28:56 +00:00
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
release-victoria-metrics-openbsd-amd64:
GOOS=openbsd GOARCH=amd64 $(MAKE) release-victoria-metrics-goos-goarch
release-victoria-metrics-goos-goarch: victoria-metrics-$(GOOS)-$(GOARCH)-prod
Makefile: add `release-victoria-metrics-arm64` build rule
2021-01-13 16:13:18 +00:00
cd bin && \
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
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
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
release-vmutils: \
Rename release packages (#2810) * makefile: add os to each release file * makefile: update vmutils arm64 * makefile: update victoria-metrics release process * makefile: update publish with os * makefile: update publish with os * makefile: change tar library * update release logic * copy all releases * sort command by GOOS * rollback commands * rollback OSARCH * fix commands * cleanup * fix windows build * sort build by GOOS, update README.md
2022-07-13 12:42:48 +00:00
release-vmutils-linux-amd64 \
release-vmutils-linux-arm64 \
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
release-vmutils-linux-arm \
Rename release packages (#2810) * makefile: add os to each release file * makefile: update vmutils arm64 * makefile: update victoria-metrics release process * makefile: update publish with os * makefile: update publish with os * makefile: change tar library * update release logic * copy all releases * sort command by GOOS * rollback commands * rollback OSARCH * fix commands * cleanup * fix windows build * sort build by GOOS, update README.md
2022-07-13 12:42:48 +00:00
release-vmutils-darwin-amd64 \
adds release build for macos darwin amd64 and arm64 (#2185) * adds release build for macos darwin amd64 and arm64 https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1896 https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1851 * wip Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-02-14 15:28:56 +00:00
release-vmutils-darwin-arm64 \
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
release-vmutils-freebsd-amd64 \
release-vmutils-openbsd-amd64 \
Makefile: prepare vmutils-windows-*.zip archive on `make release-vmutils` command The archive contains the following executables for Windows: * vmagent * vmalert * vmauth * vmctl Other components - vmbackup, vmrestore, victoria-metrics - aren't supported for Windows yet
2021-03-16 18:49:07 +00:00
release-vmutils-windows-amd64
Makefile: release vmutils for amd64 and arm64 Follow-up for 0d03855787d526e51980e5935d9a59c83f92f143
2021-01-13 16:02:28 +00:00
Rename release packages (#2810) * makefile: add os to each release file * makefile: update vmutils arm64 * makefile: update victoria-metrics release process * makefile: update publish with os * makefile: update publish with os * makefile: change tar library * update release logic * copy all releases * sort command by GOOS * rollback commands * rollback OSARCH * fix commands * cleanup * fix windows build * sort build by GOOS, update README.md
2022-07-13 12:42:48 +00:00
release-vmutils-linux-amd64:
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
GOOS=linux GOARCH=amd64 $(MAKE) release-vmutils-goos-goarch
adds release build for macos darwin amd64 and arm64 (#2185) * adds release build for macos darwin amd64 and arm64 https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1896 https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1851 * wip Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-02-14 15:28:56 +00:00
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
release-vmutils-linux-arm64:
GOOS=linux GOARCH=arm64 $(MAKE) release-vmutils-goos-goarch
Makefile: prepare vmutils-windows-*.zip archive on `make release-vmutils` command The archive contains the following executables for Windows: * vmagent * vmalert * vmauth * vmctl Other components - vmbackup, vmrestore, victoria-metrics - aren't supported for Windows yet
2021-03-16 18:49:07 +00:00
Rename release packages (#2810) * makefile: add os to each release file * makefile: update vmutils arm64 * makefile: update victoria-metrics release process * makefile: update publish with os * makefile: update publish with os * makefile: change tar library * update release logic * copy all releases * sort command by GOOS * rollback commands * rollback OSARCH * fix commands * cleanup * fix windows build * sort build by GOOS, update README.md
2022-07-13 12:42:48 +00:00
release-vmutils-linux-arm:
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
GOOS=linux GOARCH=arm $(MAKE) release-vmutils-goos-goarch
Rename release packages (#2810) * makefile: add os to each release file * makefile: update vmutils arm64 * makefile: update victoria-metrics release process * makefile: update publish with os * makefile: update publish with os * makefile: change tar library * update release logic * copy all releases * sort command by GOOS * rollback commands * rollback OSARCH * fix commands * cleanup * fix windows build * sort build by GOOS, update README.md
2022-07-13 12:42:48 +00:00
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
release-vmutils-darwin-amd64:
GOOS=darwin GOARCH=amd64 $(MAKE) release-vmutils-goos-goarch
Rename release packages (#2810) * makefile: add os to each release file * makefile: update vmutils arm64 * makefile: update victoria-metrics release process * makefile: update publish with os * makefile: update publish with os * makefile: change tar library * update release logic * copy all releases * sort command by GOOS * rollback commands * rollback OSARCH * fix commands * cleanup * fix windows build * sort build by GOOS, update README.md
2022-07-13 12:42:48 +00:00
release-vmutils-darwin-arm64:
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
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
Arch consistent filenames (#1015) * Include individual binary checksums for vmutils * Consistent archive/binary artefacts between arm64/amd64 for vmutils * architecture in arhcive, checksums * not in binaries
2021-01-13 15:31:08 +00:00
cd bin && \
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
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: \
Makefile: prepare vmutils-windows-*.zip archive on `make release-vmutils` command The archive contains the following executables for Windows: * vmagent * vmalert * vmauth * vmctl Other components - vmbackup, vmrestore, victoria-metrics - aren't supported for Windows yet
2021-03-16 18:49:07 +00:00
vmagent-windows-$(GOARCH)-prod \
vmalert-windows-$(GOARCH)-prod \
vmauth-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 \
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 \
vmctl-windows-$(GOARCH)-prod.exe \
> vmutils-windows-$(GOARCH)-$(PKG_TAG)_checksums.txt
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
cd bin && rm -rf \
vmagent-windows-$(GOARCH)-prod.exe \
vmalert-windows-$(GOARCH)-prod.exe \
vmauth-windows-$(GOARCH)-prod.exe \
vmctl-windows-$(GOARCH)-prod.exe
Makefile: prepare vmutils-windows-*.zip archive on `make release-vmutils` command The archive contains the following executables for Windows: * vmagent * vmalert * vmauth * vmctl Other components - vmbackup, vmrestore, victoria-metrics - aren't supported for Windows yet
2021-03-16 18:49:07 +00:00
reworks snap build with docker (#1910)
2021-12-08 11:05:35 +00:00
Makefile: add `pprof-cpu` rule for inspecting CPU profiles with `PPROF_FILE=/path/to/cpu.pprof make pprof-cpu`
2019-11-04 10:43:26 +00:00
pprof-cpu:
go tool pprof -trim_path=github.com/VictoriaMetrics/VictoriaMetrics@ $(PPROF_FILE)
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
fmt:
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
gofmt -l -w -s ./lib
gofmt -l -w -s ./app
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
vet:
Makefile: remove redundant `-mod=vendor` option when running Go tools The `-mod=vendor` is automatically set when there is a `vendor` directory starting from Go1.14 - see https://go.dev/doc/go1.14#go-command Since the minimum supported Go version for VictoriaMetrics is Go1.17, then the `-mod=vendor` option is no longer needed.
2022-08-07 17:39:05 +00:00
go vet ./lib/...
go vet ./app/...
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
lint: install-golint
golint lib/...
golint app/...
install-golint:
Makefile: consistently use `go install` instead of `go get` for installing various binaries needed during build/test/check of the code `go install` is the preferred way for installing go binaries starting from the minimum supported Go version for VictoriaMetrics - Go1.18 - see https://tip.golang.org/doc/go1.18#go-command
2022-09-08 15:43:02 +00:00
which golint || go install golang.org/x/lint/golint@latest
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
errcheck: install-errcheck
errcheck -exclude=errcheck_excludes.txt ./lib/...
errcheck -exclude=errcheck_excludes.txt ./app/vminsert/...
errcheck -exclude=errcheck_excludes.txt ./app/vmselect/...
errcheck -exclude=errcheck_excludes.txt ./app/vmstorage/...
app/vmagent: initial implementation for vmagent
2020-02-23 11:35:47 +00:00
errcheck -exclude=errcheck_excludes.txt ./app/vmagent/...
app/vmalert: include it into the next release
2020-04-27 21:09:35 +00:00
errcheck -exclude=errcheck_excludes.txt ./app/vmalert/...
app/vmauth: add initial version of vmauth. See https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/app/vmauth/README.md for details
2020-05-05 07:53:42 +00:00
errcheck -exclude=errcheck_excludes.txt ./app/vmauth/...
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
errcheck -exclude=errcheck_excludes.txt ./app/vmbackup/...
errcheck -exclude=errcheck_excludes.txt ./app/vmrestore/...
app/vmctl: move vmctl code from github.com/VictoriaMetrics/vmctl It is better developing vmctl tool in VictoriaMetrics repository, so it could be released together with the rest of vmutils tools such as vmalert, vmagent, vmbackup, vmrestore and vmauth.
2021-01-31 23:10:16 +00:00
errcheck -exclude=errcheck_excludes.txt ./app/vmctl/...
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
install-errcheck:
Makefile: consistently use `go install` instead of `go get` for installing various binaries needed during build/test/check of the code `go install` is the preferred way for installing go binaries starting from the minimum supported Go version for VictoriaMetrics - Go1.18 - see https://tip.golang.org/doc/go1.18#go-command
2022-09-08 15:43:02 +00:00
which errcheck || go install github.com/kisielk/errcheck@latest
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
Makefile: check for vulnerabilities in used Go packages with govulncheck when running `make check-all` See https://go.dev/blog/vuln
2022-09-08 15:35:31 +00:00
check-all: fmt vet lint errcheck golangci-lint govulncheck
[ci-ci] enable CI (#39)
2019-05-28 22:32:49 +00:00
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
test:
Makefile: remove redundant `-mod=vendor` option when running Go tools The `-mod=vendor` is automatically set when there is a `vendor` directory starting from Go1.14 - see https://go.dev/doc/go1.14#go-command Since the minimum supported Go version for VictoriaMetrics is Go1.17, then the `-mod=vendor` option is no longer needed.
2022-08-07 17:39:05 +00:00
go test ./lib/... ./app/...
[ci-ci] enable CI (#39)
2019-05-28 22:32:49 +00:00
Makefile: add build and test rules with enabled race detector. These rules have `-race` suffix Fix also `unsafe pointer conversion` errors detected by Go1.14. See https://golang.org/doc/go1.14#compiler .
2020-03-05 10:02:06 +00:00
test-race:
Makefile: remove redundant `-mod=vendor` option when running Go tools The `-mod=vendor` is automatically set when there is a `vendor` directory starting from Go1.14 - see https://go.dev/doc/go1.14#go-command Since the minimum supported Go version for VictoriaMetrics is Go1.17, then the `-mod=vendor` option is no longer needed.
2022-08-07 17:39:05 +00:00
go test -race ./lib/... ./app/...
Makefile: add build and test rules with enabled race detector. These rules have `-race` suffix Fix also `unsafe pointer conversion` errors detected by Go1.14. See https://golang.org/doc/go1.14#compiler .
2020-03-05 10:02:06 +00:00
all: add Pure Go build (pull request #114) Updates #94
2019-07-23 16:26:39 +00:00
test-pure:
Makefile: remove redundant `-mod=vendor` option when running Go tools The `-mod=vendor` is automatically set when there is a `vendor` directory starting from Go1.14 - see https://go.dev/doc/go1.14#go-command Since the minimum supported Go version for VictoriaMetrics is Go1.17, then the `-mod=vendor` option is no longer needed.
2022-08-07 17:39:05 +00:00
CGO_ENABLED=0 go test ./lib/... ./app/...
all: small updates after PR #114
2019-07-23 16:54:50 +00:00
test-full:
Makefile: remove redundant `-mod=vendor` option when running Go tools The `-mod=vendor` is automatically set when there is a `vendor` directory starting from Go1.14 - see https://go.dev/doc/go1.14#go-command Since the minimum supported Go version for VictoriaMetrics is Go1.17, then the `-mod=vendor` option is no longer needed.
2022-08-07 17:39:05 +00:00
go test -coverprofile=coverage.txt -covermode=atomic ./lib/... ./app/...
all: add Pure Go build (pull request #114) Updates #94
2019-07-23 16:26:39 +00:00
all: add support for GOARCH=386 and fix all the issues related to 32-bit architectures such as GOARCH=arm Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/212
2019-10-17 15:22:56 +00:00
test-full-386:
Makefile: remove redundant `-mod=vendor` option when running Go tools The `-mod=vendor` is automatically set when there is a `vendor` directory starting from Go1.14 - see https://go.dev/doc/go1.14#go-command Since the minimum supported Go version for VictoriaMetrics is Go1.17, then the `-mod=vendor` option is no longer needed.
2022-08-07 17:39:05 +00:00
GOARCH=386 go test -coverprofile=coverage.txt -covermode=atomic ./lib/... ./app/...
all: add support for GOARCH=386 and fix all the issues related to 32-bit architectures such as GOARCH=arm Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/212
2019-10-17 15:22:56 +00:00
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
benchmark:
Makefile: remove redundant `-mod=vendor` option when running Go tools The `-mod=vendor` is automatically set when there is a `vendor` directory starting from Go1.14 - see https://go.dev/doc/go1.14#go-command Since the minimum supported Go version for VictoriaMetrics is Go1.17, then the `-mod=vendor` option is no longer needed.
2022-08-07 17:39:05 +00:00
go test -bench=. ./lib/...
go test -bench=. ./app/...
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
all: add Pure Go build (pull request #114) Updates #94
2019-07-23 16:26:39 +00:00
benchmark-pure:
Makefile: remove redundant `-mod=vendor` option when running Go tools The `-mod=vendor` is automatically set when there is a `vendor` directory starting from Go1.14 - see https://go.dev/doc/go1.14#go-command Since the minimum supported Go version for VictoriaMetrics is Go1.17, then the `-mod=vendor` option is no longer needed.
2022-08-07 17:39:05 +00:00
CGO_ENABLED=0 go test -bench=. ./lib/...
CGO_ENABLED=0 go test -bench=. ./app/...
all: add Pure Go build (pull request #114) Updates #94
2019-07-23 16:26:39 +00:00
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
vendor-update:
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
go get -u -d ./lib/...
go get -u -d ./app/...
bump Go version to 1.19.1 (#3108) The reason is to cover vulnerability GO-2022-0969 Found in: net/http@go1.18.5 Fixed in: net/http@go1.19.1 More info: https://pkg.go.dev/vuln/GO-2022-0969 Signed-off-by: hagen1778 <roman@victoriametrics.com> Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-09-14 10:29:19 +00:00
go mod tidy -compat=1.19.1
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
go mod vendor
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
Makefile: extract `app-local` and `app-local-pure` build rules
2019-08-27 22:34:26 +00:00
app-local:
Makefile: remove redundant `-mod=vendor` option when running Go tools The `-mod=vendor` is automatically set when there is a `vendor` directory starting from Go1.14 - see https://go.dev/doc/go1.14#go-command Since the minimum supported Go version for VictoriaMetrics is Go1.17, then the `-mod=vendor` option is no longer needed.
2022-08-07 17:39:05 +00:00
CGO_ENABLED=1 go build $(RACE) -ldflags "$(GO_BUILDINFO)" -o bin/$(APP_NAME)$(RACE) $(PKG_PREFIX)/app/$(APP_NAME)
Makefile: extract `app-local` and `app-local-pure` build rules
2019-08-27 22:34:26 +00:00
app-local-pure:
Makefile: remove redundant `-mod=vendor` option when running Go tools The `-mod=vendor` is automatically set when there is a `vendor` directory starting from Go1.14 - see https://go.dev/doc/go1.14#go-command Since the minimum supported Go version for VictoriaMetrics is Go1.17, then the `-mod=vendor` option is no longer needed.
2022-08-07 17:39:05 +00:00
CGO_ENABLED=0 go build $(RACE) -ldflags "$(GO_BUILDINFO)" -o bin/$(APP_NAME)-pure$(RACE) $(PKG_PREFIX)/app/$(APP_NAME)
Makefile: extract `app-local` and `app-local-pure` build rules
2019-08-27 22:34:26 +00:00
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
app-local-goos-goarch:
Makefile: remove redundant `-mod=vendor` option when running Go tools The `-mod=vendor` is automatically set when there is a `vendor` directory starting from Go1.14 - see https://go.dev/doc/go1.14#go-command Since the minimum supported Go version for VictoriaMetrics is Go1.17, then the `-mod=vendor` option is no longer needed.
2022-08-07 17:39:05 +00:00
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)
all: add mssing APP_NAME to vm*-GOARCH builds
2020-07-31 10:42:09 +00:00
all: follow-up for d99ba3481b192d581bf6a153e40e5f99a7eb5edf
2022-07-13 13:44:39 +00:00
app-local-windows-goarch:
Makefile: remove redundant `-mod=vendor` option when running Go tools The `-mod=vendor` is automatically set when there is a `vendor` directory starting from Go1.14 - see https://go.dev/doc/go1.14#go-command Since the minimum supported Go version for VictoriaMetrics is Go1.17, then the `-mod=vendor` option is no longer needed.
2022-08-07 17:39:05 +00:00
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)
Makefile: prepare vmutils-windows-*.zip archive on `make release-vmutils` command The archive contains the following executables for Windows: * vmagent * vmalert * vmauth * vmctl Other components - vmbackup, vmrestore, victoria-metrics - aren't supported for Windows yet
2021-03-16 18:49:07 +00:00
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
quicktemplate-gen: install-qtc
qtc
install-qtc:
Makefile: consistently use `go install` instead of `go get` for installing various binaries needed during build/test/check of the code `go install` is the preferred way for installing go binaries starting from the minimum supported Go version for VictoriaMetrics - Go1.18 - see https://tip.golang.org/doc/go1.18#go-command
2022-09-08 15:43:02 +00:00
which qtc || go install github.com/valyala/quicktemplate/qtc@latest
Makefile: add `make golangci-lint` rule for running `golangci-lint run`; updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/69
2019-06-20 11:30:55 +00:00
golangci-lint: install-golangci-lint
Makefile: suppress false positives for golangci-lint on nil pointer dereference
2020-05-07 16:40:53 +00:00
golangci-lint run --exclude '(SA4003|SA1019|SA5011):' -D errcheck -D structcheck --timeout 2m
Makefile: add `make golangci-lint` rule for running `golangci-lint run`; updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/69
2019-06-20 11:30:55 +00:00
install-golangci-lint:
Makefile: update golangci-lint from v1.47.1 to v1.48.0 This is needed for adding support for Go 1.19
2022-08-07 19:32:56 +00:00
which golangci-lint || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin v1.48.0
Makefile: add `make docs-sync` command for syncing docs contents
2020-06-02 16:12:07 +00:00
Makefile: check for vulnerabilities in used Go packages with govulncheck when running `make check-all` See https://go.dev/blog/vuln
2022-09-08 15:35:31 +00:00
govulncheck: install-govulncheck
govulncheck ./...
install-govulncheck:
which govulncheck || go install golang.org/x/vuln/cmd/govulncheck@latest
Add `make check-licenses` rule for the ability to manually check licenses in vendored dependencies This is a follow-up for c687536956c6ad820bb6cbb33e1d1e02dfe7c844
2021-05-10 08:54:35 +00:00
install-wwhrd:
Makefile: consistently use `go install` instead of `go get` for installing various binaries needed during build/test/check of the code `go install` is the preferred way for installing go binaries starting from the minimum supported Go version for VictoriaMetrics - Go1.18 - see https://tip.golang.org/doc/go1.18#go-command
2022-09-08 15:43:02 +00:00
which wwhrd || go install github.com/frapposelli/wwhrd@latest
Add `make check-licenses` rule for the ability to manually check licenses in vendored dependencies This is a follow-up for c687536956c6ad820bb6cbb33e1d1e02dfe7c844
2021-05-10 08:54:35 +00:00
check-licenses: install-wwhrd
wwhrd check -f .wwhrd.yml
docs: update docs ordering and formatting (#1192) The major change is adding `sort` directive to docs. For those docs which are copied from internal packages `sort` is added via makefile command. For the rest it is added manually since they're updated manually as well. The rest of changes is connected with markdown formatting. For example, changing headers in some files (`##` => `#`) makes navigation on .github.io to look better. This especially useful for `changelog` docs. Table of contents for `vmctl` is dropped, since we already have it autogenerated on .github.io. No link changes expected. The corresponding PR to `cluster` branch will be made in follow-up PR.
2021-04-07 10:39:16 +00:00
copy-docs:
echo "---\nsort: ${ORDER}\n---\n" > ${DST}
cat ${SRC} >> ${DST}
# Copies docs for all components and adds the order tag.
# Cluster docs are supposed to be ordered as 9th.
# For The rest of docs is ordered manually.t
Makefile: add `make docs-sync` command for syncing docs contents
2020-06-02 16:12:07 +00:00
docs-sync:
move github-pages docs to the main repo (#1432) * move github-pages docs to the main repo * rm github actions for copying docs to VictoriaMetrics/VictoriaMetrics.github.io
2021-07-05 11:34:10 +00:00
cp README.md docs/README.md
docs: update docs ordering and formatting (#1192) The major change is adding `sort` directive to docs. For those docs which are copied from internal packages `sort` is added via makefile command. For the rest it is added manually since they're updated manually as well. The rest of changes is connected with markdown formatting. For example, changing headers in some files (`##` => `#`) makes navigation on .github.io to look better. This especially useful for `changelog` docs. Table of contents for `vmctl` is dropped, since we already have it autogenerated on .github.io. No link changes expected. The corresponding PR to `cluster` branch will be made in follow-up PR.
2021-04-07 10:39:16 +00:00
SRC=README.md DST=docs/Single-server-VictoriaMetrics.md ORDER=1 $(MAKE) copy-docs
Docs review (#1330) * re-order components by prioritizing Cluster-VictoriaMetrics.md * drop Home.md since it just duplicates other links
2021-05-26 09:28:58 +00:00
SRC=app/vmagent/README.md DST=docs/vmagent.md ORDER=3 $(MAKE) copy-docs
SRC=app/vmalert/README.md DST=docs/vmalert.md ORDER=4 $(MAKE) copy-docs
SRC=app/vmauth/README.md DST=docs/vmauth.md ORDER=5 $(MAKE) copy-docs
SRC=app/vmbackup/README.md DST=docs/vmbackup.md ORDER=6 $(MAKE) copy-docs
SRC=app/vmrestore/README.md DST=docs/vmrestore.md ORDER=7 $(MAKE) copy-docs
SRC=app/vmctl/README.md DST=docs/vmctl.md ORDER=8 $(MAKE) copy-docs
SRC=app/vmgateway/README.md DST=docs/vmgateway.md ORDER=9 $(MAKE) copy-docs
SRC=app/vmbackupmanager/README.md DST=docs/vmbackupmanager.md ORDER=10 $(MAKE) copy-docs
Reference in a new issue Copy permalink