Skip to content

Commit 2305b52

Browse files
docs: Update release note docs to address website release notes (#4598)
* docs: Update release note docs to address website release notes * add suggestion Co-authored-by: Marc Sanmiquel <[email protected]> --------- Co-authored-by: Marc Sanmiquel <[email protected]>
1 parent 24a049d commit 2305b52

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

docs/internal/RELEASE.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,20 @@ For help writing release notes, refer to the [Writers' Toolkit](https://grafana.
3535

3636
Please do not delete GitHub releases that were once public.
3737

38-
To release a patch version, simply merge fixes to the release branch then create and push a new tag. (e.g. `v0.x.1`). Any bugfixes or other entries should be added to the existing release notes for that version under a new heading with the version number.
38+
### Website release notes
39+
40+
Create a new branch and add release notes in `docs/sources/release-notes`.
41+
Once the PR is merged, cherry-pick this commit on to the `release/vX.Y` branch
42+
to trigger the `publish-technical-documentation-release.yml` action.
43+
44+
### Helm charts update
3945

40-
> For helm charts, you need to merge a PR that bumps the chart version in the main branch (no tagging required), the CI will automatically publish the chart to the [helm repository](https://grafana.github.io/helm-charts).
46+
Merge a PR that bumps the chart version in the main branch (no tagging required), the CI will automatically publish the chart to the [helm repository](https://grafana.github.io/helm-charts).
47+
You can combine this update and the [Website release notes](#website-release-notes) updates in to the same PR.
48+
49+
### Patch version release
50+
51+
To release a patch version, simply merge fixes to the release branch then create and push a new tag. (e.g. `v0.x.1`). Any bugfixes or other entries should be added to the existing release notes for that version under a new heading with the version number.
4152

4253
## Manual Release Process
4354

0 commit comments

Comments
 (0)