docs/Release-Guide.md: document that feature docs must be updated with the release where the feature appeared

This commit is contained in:
Aliaksandr Valialkin 2022-07-30 00:15:49 +03:00
parent 78520f2702
commit 90649de0c4
No known key found for this signature in database
GPG Key ID: A72BEC6CD3D0DED1

View File

@ -7,7 +7,8 @@ sort: 18
## Release version and Docker images ## Release version and Docker images
0. Make sure that the release commits have no security issues. 0. Make sure that the release commits have no security issues.
1. Document all the changes for new release in [CHANGELOG.md](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/CHANGELOG.md). 1a. Document all the changes for new release in [CHANGELOG.md](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/CHANGELOG.md).
1b. Add `(available in v1.xx.y)` line to feature docs introduced in the upcoming release.
2. Create the following release tags: 2. Create the following release tags:
* `git tag -s v1.xx.y` in `master` branch * `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-cluster` in `cluster` branch