Skip to content

Commit 4d0d8b2

Browse files
authored
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.
1 parent f04beeb commit 4d0d8b2

File tree

2 files changed

+23
-18
lines changed

2 files changed

+23
-18
lines changed

.goreleaser.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,10 @@ changelog:
154154
release:
155155
draft: true
156156
footer: |
157-
As always, feedbacks are more than welcome, feel free to open issues/discussions.
157+
As always, feedback is more than welcome, feel free to open issues/discussions.
158158
You can reach out to the team using:
159159
160-
- [Slack](https://grafana.slack.com/archives/C047CCW6YM8)
160+
- [Slack](https://grafana.slack.com/archives/C049PLMV8TB)
161161
- [Github Discussions](https://github.com/grafana/pyroscope/discussions)
162162
- [Github Issues](https://github.com/grafana/pyroscope/issues)
163163
- [Mailing List](https://groups.google.com/g/pyroscope-team)

docs/internal/RELEASE.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
## Automatic Release Process
44

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:
1111

1212
```gh label create "backport release/vX.Y" -d "This label will backport a merged PR to the release/vX.Y branch" -c "#0052cc"```
1313

@@ -22,6 +22,10 @@ The CI will automatically handle the build and create a draft GitHub release.
2222

2323
Once ready, you can edit and publish the draft release on GitHub.
2424

25+
Please do not delete GitHub releases that were once public.
26+
27+
### Release notes
28+
2529
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:
2630

2731
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
3337

3438
For help writing release notes, refer to the [Writers' Toolkit](https://grafana.com/docs/writers-toolkit/write/).
3539

36-
Please do not delete GitHub releases that were once public.
40+
### Helm charts update
3741

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).
3943

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
4345

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.
4548

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.
49+
[Example backport PR](https://github.com/grafana/pyroscope/pull/4352)
50+
51+
## Patch releases
4852

49-
### Patch version release
53+
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.
5055

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.
5257

5358
## Manual Release Process
5459

0 commit comments

Comments
 (0)