You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Update release documentation to address pain points (#4626)
* docs: Update release documentation to address pain points
Original pain points identified:
1. Clarify label back porting flow
2. Fix broken documentation release
3. Fix :latest docker tag issue
(1) and (2) are addressed by this change. (3) has been
captured in an issue: grafana/pyroscope-squad#645.
Copy file name to clipboardExpand all lines: docs/internal/RELEASE.md
+21-16Lines changed: 21 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,12 @@
2
2
3
3
## Automatic Release Process
4
4
5
-
To release a new version of the project you need to follow the following steps:
6
-
7
-
1. Create a new branch for the release (e.g., `release/vX.Y`)
8
-
2. Create the tag for the release (e.g., `vX.Y.Z`)
9
-
3. Push the release branch and tag to the remote
10
-
4. Create a GitHub label for backports:
5
+
1. Update [release notes](#release-notes)
6
+
2. Create a new branch for the release (e.g., `release/vX.Y`). Make sure the release notes are present on this branch or
7
+
[backported](#backport) later.
8
+
3. Create the tag for the release (e.g., `vX.Y.Z`)
9
+
4. Push the release branch and tag to the remote. Note that the tag will kick off a real release via goreleaser.
10
+
5. Create a GitHub label for backports:
11
11
12
12
```gh label create "backport release/vX.Y" -d "This label will backport a merged PR to the release/vX.Y branch" -c "#0052cc"```
13
13
@@ -22,6 +22,10 @@ The CI will automatically handle the build and create a draft GitHub release.
22
22
23
23
Once ready, you can edit and publish the draft release on GitHub.
24
24
25
+
Please do not delete GitHub releases that were once public.
26
+
27
+
### Release notes
28
+
25
29
The list of changes from the GitHub release form the basis of the public-facing release notes. Release notes are added to the [public Pyroscope documentation](https://grafana.com/docs/pyroscope/latest/release-notes/). These release notes follow the same pattern for each release:
26
30
27
31
1. Copy the previous release's page (i.e., V1-3.md) to the new release number. Change the version information and [page weight](https://grafana.com/docs/writers-toolkit/write/front-matter/#weight) in the file's frontmatter.
@@ -33,22 +37,23 @@ The list of changes from the GitHub release form the basis of the public-facing
33
37
34
38
For help writing release notes, refer to the [Writers' Toolkit](https://grafana.com/docs/writers-toolkit/write/).
35
39
36
-
Please do not delete GitHub releases that were once public.
40
+
### Helm charts update
37
41
38
-
### Website release notes
42
+
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).
39
43
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.
44
+
## Backport
43
45
44
-
### Helm charts update
46
+
A PR to be backported must have the appropriate `backport release/vX.Y` label(s) AND one of [these expected labels](https://github.com/grafana/grafana-github-actions/blob/7d2b4af1112747f82e12adfbc00be44fecb3b616/backport/backport.ts#L16):
47
+
`['type/docs', 'type/bug', 'product-approved', 'type/ci']`. Note that these labels must be present before the PR is merged.
45
48
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.
Any bugfixes or other entries should be added to the existing release notes for that version under a new heading with
54
+
the version number. The changes should be on the appropriate release branch.
50
55
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.
56
+
Once merged, a `vX.Y.Z` patch release tag must be created and pushed to remote to create a new release.
0 commit comments