github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-12-01 14:47:38 +00:00
Code Issues Projects Releases Packages Wiki Activity
VictoriaMetrics/docs/Release-Guide.md

188 lines
13 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 10:39:16 +00:00
---
VMAnomaly docs fixes (#2361) * 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 10:08:17 +00:00
sort: 18
prepare static docs to migration Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-04-30 10:31:45 +00:00
weight: 18
title: Release process guidance
menu:
docs:
parent: "victoriametrics"
weight: 18
aliases:
- /Release-Guide.html
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
---
# Release process guidance
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
## Pre-reqs
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
1. Make sure you have enterprise remote configured
```
git remote add enterprise <url>
```
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. Make sure you have singing key configured
1. Make sure you have github token with at least `read:org, repo, write:packages` permissions exported under `GITHUB_TOKEN` env variable.
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
You can create token [here](https://github.com/settings/tokens)
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. Make sure you're [authorized](https://hub.docker.com/orgs/victoriametrics/settings/enforce-sign-in/windows) for pushing docker images
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
docs/release-guide: update instructions (#4391) docs/release-guide: update instructions for MacOS users Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-06-13 08:37:51 +00:00
### For MacOS users
Make sure you have GNU version of utilities `zip`, `tar`, `sha256sum`. To install them run the following commands:
```bash
brew install coreutils
brew install gnu-tar
export PATH="/usr/local/opt/coreutils/libexec/gnubin:$PATH"
```
Docker may need additional configuration changes:
```bash
docker buildx create --use --name=qemu
docker buildx inspect --bootstrap
```
For ARM arch (M1/M2 processors) additionally configure docker with preferred platform:
```
export DOCKER_DEFAULT_PLATFORM=linux/amd64
```
By default, docker on MacOS has limited amount of resources (CPU, mem) to use.
Bumping the limits may significantly improve build speed.
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
## Release version and Docker images
docs/Release-Guide.md: document that changes must be synced between branches immediately after the commit in any branch
2023-08-11 11:29:04 +00:00
1. Make sure all the changes are documented in [CHANGELOG.md](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/CHANGELOG.md).
Ideally, every change must be documented in the commit with the change. Alternatively, the change must be documented immediately
after the commit, which adds the change.
1. Make sure all the changes are synced between `master`, `cluster`, `enterprise-single-node` and `enteprise-cluster` branches.
Changes in these branches must be synced immediately after they are commited in at least a single branch.
1. Make sure that the release branches have no security issues.
1. Update release versions if needed in [SECURITY.md](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/SECURITY.md).
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. Add `(available starting from v1.xx.y)` line to feature docs introduced in the upcoming release.
1. Cut new version in [CHANGELOG.md](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/CHANGELOG.md)
docs/Release-Guide.md: document that changes must be synced between branches immediately after the commit in any branch
2023-08-11 11:29:04 +00:00
and make it merged. See example in this [commit](https://github.com/VictoriaMetrics/VictoriaMetrics/commit/b771152039d23b5ccd637a23ea748bc44a9511a7).
docs: consistently use https://docs.victoriametrics.com/lts-releases/ link for LTS releases
2024-03-01 00:51:41 +00:00
1. Cherry-pick bug fixes relevant for [LTS releases](https://docs.victoriametrics.com/lts-releases/).
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. Make sure you get all changes fetched `git fetch --all`.
1. Create the following release tags:
docs/Release-Guide.md: add instructions on how to create signed release tags
2022-01-31 17:18:48 +00:00
* `git tag -s v1.xx.y` in `master` branch
* `git tag -s v1.xx.y-cluster` in `cluster` branch
docs/Release-Guide.md: document that changes must be synced between branches immediately after the commit in any branch
2023-08-11 11:29:04 +00:00
* `git tag -s v1.xx.y-enterprise` in `enterprise-single-node` branch
docs/Release-Guide.md: add instructions on how to create signed release tags
2022-01-31 17:18:48 +00:00
* `git tag -s v1.xx.y-enterprise-cluster` in `enterprise-cluster` branch
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. Run `TAG=v1.xx.y make publish-release`. This command performs the following tasks:
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
a) Build and package binaries in `*.tar.gz` release archives with the corresponding `_checksums.txt` files inside `bin` directory.
This step can be run manually with the command `make release` from the needed git tag.
b) Build and publish [multi-platform Docker images](https://docs.docker.com/build/buildx/multiplatform-images/)
for the given `TAG`, `TAG-cluster`, `TAG-enterprise` and `TAG-enterprise-cluster`.
The multi-platform Docker image is built for the following platforms:
* linux/amd64
* linux/arm64
* linux/arm
* linux/ppc64le
* linux/386
This step can be run manually with the command `make publish` from the needed git tag.
docs: fix step references in Release-Guide.md Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-28 09:44:31 +00:00
1. Push the tags `v1.xx.y` and `v1.xx.y-cluster` created at step 8 to public GitHub repository at https://github.com/VictoriaMetrics/VictoriaMetrics.
docs: mention tags routing for new release (#4566) * docs: mention tags routing for new release Signed-off-by: hagen1778 <roman@victoriametrics.com> * Update docs/Release-Guide.md --------- Signed-off-by: hagen1778 <roman@victoriametrics.com> Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2023-07-19 23:55:10 +00:00
Push the tags `v1.xx.y`, `v1.xx.y-cluster`, `v1.xx.y-enterprise` and `v1.xx.y-enterprise-cluster` to the corresponding
branches in private repository.
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
**Important note:** do not push enterprise tags to public GitHub repository - they must be pushed only to private repository.
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. Run `TAG=v1.xx.y make github-create-release github-upload-assets`. This command performs the following tasks:
docs/Release-Guide.md: require manual push of the created release tags to public Github The automated push of release tags to Github require specifying the remote repository name when doing `git push <remote-repo-name> v1.xx.y`. The remote repository name can differ in different environments, so it cannot be put into Makefile rule. TODO: create a Makefile rule, which generates standard remote names for public and private repositories in Git, so `git push` for release tags could be automated then.
2022-09-08 11:51:17 +00:00
a) Create draft GitHub release with the name `TAG`. This step can be run manually
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
with the command `TAG=v1.xx.y make github-create-release`.
The release id is stored at `/tmp/vm-github-release` file.
docs: fix step references in Release-Guide.md Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-28 09:44:31 +00:00
b) Upload all the binaries and checksums created at step `9a` to that release.
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
This step can be run manually with the command `make github-upload-assets`.
It is expected that the needed release id is stored at `/tmp/vm-github-release` file,
docs/Release-Guide.md: require manual push of the created release tags to public Github The automated push of release tags to Github require specifying the remote repository name when doing `git push <remote-repo-name> v1.xx.y`. The remote repository name can differ in different environments, so it cannot be put into Makefile rule. TODO: create a Makefile rule, which generates standard remote names for public and private repositories in Git, so `git push` for release tags could be automated then.
2022-09-08 11:51:17 +00:00
which must be created at the step `a`.
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
If the upload process is interrupted by any reason, then the following recovery steps must be performed:
- To delete the created draft release by running the command `make github-delete-release`.
This command expects that the id of the release to delete is located at `/tmp/vm-github-release`
docs/Release-Guide.md: require manual push of the created release tags to public Github The automated push of release tags to Github require specifying the remote repository name when doing `git push <remote-repo-name> v1.xx.y`. The remote repository name can differ in different environments, so it cannot be put into Makefile rule. TODO: create a Makefile rule, which generates standard remote names for public and private repositories in Git, so `git push` for release tags could be automated then.
2022-09-08 11:51:17 +00:00
file created at the step `a`.
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
- To run the command `TAG=v1.xx.y make github-create-release github-upload-assets`, so new release is created
and all the needed assets are re-uploaded to it.
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. Go to <https://github.com/VictoriaMetrics/VictoriaMetrics/releases> and verify that draft release with the name `TAG` has been created
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
and this release contains all the needed binaries and checksums.
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. Update the release description with the content of [CHANGELOG](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/CHANGELOG.md) for this release.
1. Publish release by pressing "Publish release" green button in GitHub's UI.
1. Bump version of the VictoriaMetrics cluster in the [sandbox environment](https://github.com/VictoriaMetrics/ops/blob/main/gcp-test/sandbox/manifests/benchmark-vm/vmcluster.yaml)
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
by [opening and merging PR](https://github.com/VictoriaMetrics/ops/pull/58).
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. Bump VictoriaMetrics version at `deployment/docker/docker-compose.yml` and at `deployment/docker/docker-compose-cluster.yml`.
docs: add link to release-guide follow-up Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-07-31 12:05:17 +00:00
1. Follow the instructions in [release follow-up](https://github.com/VictoriaMetrics/VictoriaMetrics-enterprise/blob/master/Release-Guide.md).
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
## Building snap package
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
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
pre-requirements:
* snapcraft binary, can be installed with commands:
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
for MacOS `brew install snapcraft` and [install multipass](https://discourse.ubuntu.com/t/installing-multipass-on-macos/8329),
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
for Ubuntu - `sudo snap install snapcraft --classic`
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
* 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).
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
Update release process. Actualize helm-charts release process. Add re… (#2397) * Update release process. Actualize helm-charts release process. Add release guide for ansible playbooks * add step to Ansible steps
2022-04-04 09:14:27 +00:00
1. checkout to the latest git tag for single-node version.
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. execute `make release-snap` - it must build and upload snap package.
1. promote release to current, if needed manually at release page [snapcraft-releases](https://snapcraft.io/victoriametrics/releases)
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
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
### Public Announcement
Announcement guide
2020-12-19 19:58:03 +00:00
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00: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/>
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
* Post in LinkedIn at <https://www.linkedin.com/company/victoriametrics/>
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
* Publish message in Telegram at <https://t.me/VictoriaMetrics_en> and <https://t.me/VictoriaMetrics_ru1>
fixed typos in documentation and commandline flags descriptions (#4275)
2023-05-10 07:50:41 +00:00
* 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 17:28:21 +00:00
## Helm Charts
The helm chart repository [https://github.com/VictoriaMetrics/helm-charts/](https://github.com/VictoriaMetrics/helm-charts/)
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
### Bump the version of images
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
docs/release-guide: update instructions (#4391) docs/release-guide: update instructions for MacOS users Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-06-13 08:37:51 +00:00
Bump `tag` field in `values.yaml` with new release version.
Bump `appVersion` field in `Chart.yaml` with new release version.
Bump `version` field in `Chart.yaml` with incremental semver version.
Do these updates to the following charts:
Update release process. Actualize helm-charts release process. Add re… (#2397) * Update release process. Actualize helm-charts release process. Add release guide for ansible playbooks * add step to Ansible steps
2022-04-04 09:14:27 +00:00
1. Update `vmagent` chart version in [`values.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-agent/values.yaml) and [`Chart.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-agent/Chart.yaml)
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. Update `vmalert` chart version in [`values.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-alert/values.yaml) and [`Chart.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-alert/Chart.yaml)
1. Update `vmauth` chart version in [`values.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-auth/values.yaml) and [`Chart.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-auth/Chart.yaml)
1. Update `cluster` chart versions in [`values.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-cluster/values.yaml), bump version for `vmselect`, `vminsert` and `vmstorage` and [`Chart.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-cluster/Chart.yaml)
1. Update `k8s-stack` chart versions in [`values.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-k8s-stack/values.yaml), bump version for `vmselect`, `vminsert`, `vmstorage`, `vmsingle`, `vmalert`, `vmagent` and [`Chart.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-k8s-stack/Chart.yaml)
1. Update `single-node` chart version in [`values.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-single/values.yaml) and [`Chart.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-single/Chart.yaml)
1. Update `vmgateway` chart version in [`values.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-gateway/values.yamll) and [`Chart.yaml`](https://github.com/VictoriaMetrics/helm-charts/blob/master/charts/victoria-metrics-gateway/Chart.yaml)
docs/release-guide: update instructions (#4391) docs/release-guide: update instructions for MacOS users Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-06-13 08:37:51 +00:00
Once updated, run the following commands:
1. Run `make gen-docs`
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. Run `make package` that creates or updates zip file with the packed chart
1. Run `make merge`. It creates or updates metadata for charts in index.yaml
1. Push changes to master. `master` is a source of truth
1. Push the same changes to `gh-pages` branch
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Update release process. Actualize helm-charts release process. Add re… (#2397) * Update release process. Actualize helm-charts release process. Add release guide for ansible playbooks * add step to Ansible steps
2022-04-04 09:14:27 +00:00
## Ansible Roles
A good change for MD files (#2353) * Lint YAML * Remove extra comment * Fix command problem * Format MD files * Format & fix problem of MD files for docs * Another fix for MD files
2022-03-22 11:40:55 +00:00
Update release process. Actualize helm-charts release process. Add re… (#2397) * Update release process. Actualize helm-charts release process. Add release guide for ansible playbooks * add step to Ansible steps
2022-04-04 09:14:27 +00:00
### Bump the version of images
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Update release process. Actualize helm-charts release process. Add re… (#2397) * Update release process. Actualize helm-charts release process. Add release guide for ansible playbooks * add step to Ansible steps
2022-04-04 09:14:27 +00:00
Repository [https://github.com/VictoriaMetrics/ansible-playbooks](https://github.com/VictoriaMetrics/ansible-playbooks)
docs: add docs as in the single-node branch
2019-12-05 17:28:21 +00:00
Update release process. Actualize helm-charts release process. Add re… (#2397) * Update release process. Actualize helm-charts release process. Add release guide for ansible playbooks * add step to Ansible steps
2022-04-04 09:14:27 +00:00
1. Update `vmagent` version in [`main.yml`](https://github.com/VictoriaMetrics/ansible-playbooks/blob/master/roles/vmagent/defaults/main.yml#L4)
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. Update `vmalert` version in [`main.yml`](https://github.com/VictoriaMetrics/ansible-playbooks/blob/master/roles/vmalert/defaults/main.yml#L4)
1. Update `cluster` version in [`main.yml`](https://github.com/VictoriaMetrics/ansible-playbooks/blob/master/roles/cluster/defaults/main.yml#L3)
1. Update `single` version in [`main.yml`](https://github.com/VictoriaMetrics/ansible-playbooks/blob/master/roles/single/defaults/main.yml#L6)
1. Commit changes
1. Create a new tag
1. Create a new release. This automatically publishes the new versions to galaxy.ansible.com
docs/Release-Guide.md: adds release scenario for RPM LTS packages (#3588)
2023-01-04 13:36:14 +00:00
## RPM packages
docs/release-guide: update instructions (#4391) docs/release-guide: update instructions for MacOS users Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-06-13 08:37:51 +00:00
### Bump the version of components (for LTS releases only)
docs/Release-Guide.md: adds release scenario for RPM LTS packages (#3588)
2023-01-04 13:36:14 +00:00
docs/Release-Guide.md: added missed link to rpm repository (#3623)
2023-01-10 09:14:56 +00:00
Repository [https://github.com/VictoriaMetrics/victoriametrics-lts-rpm](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm)
docs/Release-Guide.md: adds release scenario for RPM LTS packages (#3588)
2023-01-04 13:36:14 +00:00
1. Update `vmagent` version in [`vmagent.spec`](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmagent.spec#L2)
docs/Release-Guide.md: use `1.` instead of `N.` in numbered bullets, so they are automatically adjusted by Github Markdown engine See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 21:08:19 +00:00
1. Update `vmalert` version in [`vmalert.spec`](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmalert.spec#L2)
1. Update `vmauth` version in [`vmauth.spec`](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmauth.spec#L2)
1. Update `vmbackup` version in [`vmbackup.spec`](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmbackup.spec#L2)
1. Update `vmctl` version in [`vmctl.spec`](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmctl.spec#L2)
1. Update `vmrestore` version in [`vmrestore.spec`](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmrestore.spec#L2)
1. Update `vminsert` version in [`vminsert.spec`](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vminsert.spec#L2)
1. Update `vmselect` version in [`vmselect.spec`](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmselect.spec#L2)
1. Update `vmstorage` version in [`vmstorage.spec`](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmstorage.spec#L2)
1. Update `vmsingle` version in [`vmsingle.spec`](https://github.com/VictoriaMetrics/victoriametrics-lts-rpm/blob/master/vmsingle.spec#L2)
1. Commit and push changes to the repository. This will automatically build and publish new versions of RPM packages.
Reference in a new issue Copy permalink