From 803c02e6f305e21639cc3d7bc15fdd25371bdccd Mon Sep 17 00:00:00 2001 From: hagen1778 Date: Fri, 2 Aug 2024 10:56:04 +0200 Subject: [PATCH] docs: mention step for re-building js static files Changes to .ts files in vmui or vmui for logs require re-building static files that will be included into compiled binary afterwards. We don't update static files on each .ts change PR because it results in too many changes and complicates review. So we need to update these static files before the actual release. Signed-off-by: hagen1778 --- docs/Release-Guide.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Release-Guide.md b/docs/Release-Guide.md index 71684e92d..28fa797fa 100644 --- a/docs/Release-Guide.md +++ b/docs/Release-Guide.md @@ -43,6 +43,7 @@ Bumping the limits may significantly improve build speed. 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. Run `make vmui-update` and `make vmui-logs-update` commands to re-build static files for `vmui`. See [commit example](https://github.com/VictoriaMetrics/VictoriaMetrics/commit/9dde5b8ee3fdc9d4cd495c8118e04ff4ee32e650). 1. Make sure all the changes are synced between `master`, `cluster`, `enterprise-single-node` and `enterprise-cluster` branches. Changes in these branches must be synced immediately after they are committed in at least a single branch. 1. Make sure that the release branches have no security issues.