mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-12-11 14:53:49 +00:00

* Added docs for vmanomaly

* Add example images

* Stylistic fixes

* Move images to root

* Update docs/vmanomaly.md

* Update docs/vmanomaly.md

Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>

* Squeeze vmanomaly after vmbackupmanager before Case Studies

Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>

2022-03-25 12:08:17 +02:00

4 KiB

Raw Blame History

sort
18

Release process guidance

Release version and Docker images

Document all the changes for new release in CHANGELOG.md.
Create the following release tags:
- git tag -s v1.xx.y in master branch
- git tag -s v1.xx.y-cluster in cluster branch
- git tag -s v1.xx.y-enterprise in enterprise branch
- git tag -s v1.xx.y-enterprise-cluster in enterprise-cluster branch
Run TAG=v1.xx.y make publish-release. It will create *.tar.gz release archives with the corresponding _checksums.txt files inside bin directory and publish Docker images for the given TAG, TAG-cluster, TAG-enterprise and TAG-enterprise-cluster.
Push release tag to https://github.com/VictoriaMetrics/VictoriaMetrics : git push origin v1.xx.y.
Go to https://github.com/VictoriaMetrics/VictoriaMetrics/releases , create new release from the pushed tag on step 5 and upload *.tar.gz archive with the corresponding _checksums.txt from step 2.

Building snap package

pre-requirements:

snapcraft binary, can be installed with commands: for MacOS brew install snapcraft and install mutipass, for Ubuntu - sudo snap install snapcraft --classic
exported snapcraft login to ~/.snap/login.json with snapcraft export-login login.json && mkdir -p ~/.snap && mv login.json ~/.snap/
already created release at github (it operates git describe version, so git tag must be annotated).

checkout to the latest git tag for single-node version.
execute make release-snap - it must build and upload snap package.
promote release to current, if needed manually at release page snapcraft-releases

Public Announcement

Publish message in Slack at https://victoriametrics.slack.com
Post at Twitter at https://twitter.com/MetricsVictoria
Post in Reddit at https://www.reddit.com/r/VictoriaMetrics/
Post in Linkedin at https://www.linkedin.com/company/victoriametrics/
Publish message in Telegram at https://t.me/VictoriaMetrics_en and https://t.me/VictoriaMetrics_ru1
Publish message in google groups at https://groups.google.com/forum/#!forum/victorametrics-users

Helm Charts

The helm chart repository https://github.com/VictoriaMetrics/helm-charts/

Bump the version of images

In that case, don't need to bump the helm chart version

Need to update values.yaml, bump version for vmselect, vminsert and vmstorage
Specify the correct version in Chart.yaml
Update version README.md, specify the new version in the documentation
Push changes to master. master is a source of truth
Rebase master into gh-pages branch
Run make package which creates or updates zip file with the packed chart
Run make merge. It creates or updates metadata for charts in index.yaml
Push the changes to gh-pages branch

Updating the chart

Update chart version in Chart.yaml
Update README.md file, reflect changes in the documentation.
Repeat the procedure from step 4 previous section.

Wiki pages

All changes from docs folder and .md extension automatically push to Wiki

Note: no vice versa, direct changes on Wiki will be overitten after any changes in docs/*.md

Github pages

All changes in README.md, docs folder and .md extension automatically push to Wiki

4 KiB Raw Blame History