From b720e82c6e84f2a0b03acd39a0bc9d7583b22761 Mon Sep 17 00:00:00 2001 From: Vladimir Varankin Date: Mon, 14 Oct 2024 12:33:19 +0200 Subject: [PATCH] update release notes Signed-off-by: Vladimir Varankin --- RELEASE.md | 8 +++++--- operations/helm/charts/mimir-distributed/RELEASE.md | 6 +++++- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 8479f973b25..55c0bbfe710 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -109,9 +109,9 @@ If something is not clear, you can get back to this document to learn more about - [ ] Vendor the release commit of Mimir into Grafana Enterprise Metrics (GEM) - _This is addressed by Grafana Labs_ - [ ] Publish a `mimir-distributed` Helm chart release candidate. Follow the instructions in [Release process for a release candidate](https://github.com/grafana/mimir/blob/main/operations/helm/charts/mimir-distributed/RELEASE.md#release-process-for-a-release-candidate) -- [ ] Promote experimental features to experimental and remove deprecated features for the **next** release: - - [ ] Open a PR for every experimental feature we want to promote to stable - - [ ] Open a PR to remove any deprecated feature or configuration option that should be removed in the next release +- [ ] Promote experimental features to stable and remove deprecated features for the **next** release: + - [ ] Open a PR into `main` branch for every experimental feature we want to promote to stable + - [ ] Open a PR into `main` branch with any deprecated feature or configuration option removed in the next release ### Publish the stable release @@ -138,6 +138,7 @@ If something is not clear, you can get back to this document to learn more about ```bash ./tools/release/create-pr-to-merge-release-branch-to-main.sh ``` + This prepares a PR into `main` branch. On approval, **use** the `merge-approved-pr-branch-to-main.sh` script or follow the [instrictions](https://github.com/grafana/mimir/blob/main/RELEASE.md#merging-release-branch-into-main) on how to merge it with "Merge commit" (i.e. we DO NOT "squash and merge" this one). - [ ] If during the release process settings in the `renovate.json5` have been modified in such a way that dependency updates maintain more than the latest two minor versions, modify it again to ensure that only the latest two minor versions get updated. For instance, if versions 3.1, 3.0 and 2.10 are configured in `renovate.json5`, `renovate.json5` should keep updated the following branches: @@ -148,6 +149,7 @@ If something is not clear, you can get back to this document to learn more about - [ ] Open a PR to update the mixin in ["Self-hosted Grafana Mimir" integration](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-mimir/) - _This is addressed by Grafana Labs_ - [ ] [Publish dashboards to grafana.com](https://github.com/grafana/mimir/blob/main/RELEASE.md#publish-a-stable-release) + - _This is addressed by Grafana Labs_ - [ ] After publishing a GEM release publish the `mimir-distributed` Helm chart. Follow the instructions in [Release process for a final release](https://github.com/grafana/mimir/blob/main/operations/helm/charts/mimir-distributed/RELEASE.md#release-process-for-a-final-release) ```` diff --git a/operations/helm/charts/mimir-distributed/RELEASE.md b/operations/helm/charts/mimir-distributed/RELEASE.md index 6c8aa85f102..f54cf8edafb 100644 --- a/operations/helm/charts/mimir-distributed/RELEASE.md +++ b/operations/helm/charts/mimir-distributed/RELEASE.md @@ -151,10 +151,14 @@ The [release process](https://github.com/grafana/mimir/blob/main/.github/workflo For example `user/update-mimir-distributed-release-x.y-final`. -1. Optionally finalise release note and update version in the `user/update-mimir-distributed-release-x.y-final` branch. +1. Optionally finalize release note and update version in the `user/update-mimir-distributed-release-x.y-final` branch. - Update and finalize the release notes in `docs/sources/helm-charts/mimir-distributed/release-notes` directory if there has been some changes after release candidate. + - Finalize the chart's changelog. Update the title of the release section, setting it to the final release version number. + + For example, `## 4.5.0`. + - Set the `version` field, in the [Chart.yaml](https://github.com/grafana/mimir/blob/main/operations/helm/charts/mimir-distributed/Chart.yaml) file, to the desired final release version. For example, `4.5.0`.