Skip to content

Commit

Permalink
Update release instructions (#9612)
Browse files Browse the repository at this point in the history
* update release instructions

Signed-off-by: Vladimir Varankin <[email protected]>

* Apply suggestions from code review

Co-authored-by: Jon Kartago Lamida <[email protected]>

---------

Signed-off-by: Vladimir Varankin <[email protected]>
Co-authored-by: Jon Kartago Lamida <[email protected]>
  • Loading branch information
narqo and lamida authored Oct 14, 2024
1 parent c5055f8 commit 3ceec52
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
9 changes: 6 additions & 3 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,14 +104,15 @@ 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, following the [instruction](https://github.com/grafana/mimir/blob/main/RELEASE.md#merging-release-branch-into-main) on how to merge the PR with "Merge commit" (i.e. we DO NOT "Squash and merge" this one).
- [ ] Publish the Github pre-release draft after getting review from at least one maintainer
- [ ] Announce the release candidate on social media such as on Mimir community slack using your own Twitter, Mastodon or LinkedIn account
- [ ] 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

Expand All @@ -138,6 +139,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, following the [instruction](https://github.com/grafana/mimir/blob/main/RELEASE.md#merging-release-branch-into-main) on how to merge the PR 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:
Expand All @@ -148,6 +150,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)
````

Expand Down
6 changes: 5 additions & 1 deletion operations/helm/charts/mimir-distributed/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 by 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`.
Expand Down

0 comments on commit 3ceec52

Please sign in to comment.