Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-12-15 08:23:34 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
989668beba
VictoriaMetrics/docs/Release-Guide.md

73 lines
4.0 KiB
Markdown
Raw Normal View History

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 12:39:16 +02:00
---
docs: remove SampleSizeCalculations.md, since it is outdated and no longer used There was a reference to this doc from the old victoriametrics.com site
2021-07-28 18:24:23 +02:00
sort: 17
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 12:39:16 +02:00
---
# Release process guidance
docs: add docs as in the single-node branch
2019-12-05 18:28:21 +01:00
## Release version and Docker images
Move CHANGELOG.md to docs/CHANGELOG.md
2020-11-09 23:36:32 +01:00
0. Document all the changes for new release in [CHANGELOG.md](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/CHANGELOG.md).
Makefile: add `TAG=v... make publish-release` rule for building and publishing a release for the given TAG
2021-11-08 11:29:10 +01:00
1. Create the following release tags:
docs/Release-Guide.md: add instructions on how to create signed release tags
2022-01-31 18:18:48 +01:00
* `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
Makefile: add `TAG=v... make publish-release` rule for building and publishing a release for the given TAG
2021-11-08 11:29:10 +01:00
2. 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`.
docs/Release-Guide.md: actualize release docs
2020-12-15 20:10:43 +01:00
5. Push release tag to https://github.com/VictoriaMetrics/VictoriaMetrics : `git push origin v1.xx.y`.
6. 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.
docs: add docs as in the single-node branch
2019-12-05 18:28:21 +01:00
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 10:43:09 +01:00
## Building snap package.
pre-requirements:
- snapcraft binary, can be installed with commands:
for MacOS `brew install snapcraft` and [install mutipass](https://discourse.ubuntu.com/t/installing-multipass-on-macos/8329),
for Ubuntu - `sudo snap install snapcraft --classic`
docs/Release-Guide.md: update instructions for exporting snapcraft login to ~/.snap/login.json
2022-01-19 14:20:59 +01:00
- exported snapcraft login to `~/.snap/login.json` with `snapcraft export-login login.json && mkdir -p ~/.snap && mv login.json ~/.snap/`
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 10:43:09 +01:00
- already created release at github (it operates `git describe` version, so git tag must be annotated).
0. checkout to the latest git tag for single-node version.
1. execute `make release-snap` - it must build and upload snap package.
2. promote release to current, if needed manually at release page [snapcraft-releases](https://snapcraft.io/victoriametrics/releases)
Announcement guide
2020-12-19 20:58:03 +01:00
### Public Announcement
docs/Release-Guide.md: refresh the list of channels for publishing release notes
2021-12-08 12:15:05 +01:00
- 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
docs: add docs as in the single-node branch
2019-12-05 18:28:21 +01:00
## Helm Charts
The helm chart repository [https://github.com/VictoriaMetrics/helm-charts/](https://github.com/VictoriaMetrics/helm-charts/)
### Bump the version of images.
In that case, don't need to bump the helm chart version
1. Need to update [`values.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-cluster/values.yaml), bump version for `vmselect`, `vminsert` and `vmstorage`
2. Specify the correct version in [`Chart.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-cluster/Chart.yaml)
3. Update version [README.md](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-cluster/README.md), specify the new version in the documentation
4. Push changes to master. `master` is a source of truth
5. Rebase `master` into `gh-pages` branch
6. Run `make package` which creates or updates zip file with the packed chart
7. Run `make merge`. It creates or updates metadata for charts in index.yaml
8. Push the changes to `gh-pages` branch
### Updating the chart.
1. Update chart version in [`Chart.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-cluster/Chart.yaml)
2. Update [README.md](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-cluster/README.md) file, reflect changes in the documentation.
3. 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
Reference in New Issue Copy Permalink