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
Copy file name to clipboardExpand all lines: docs/internal/RELEASE.md
+11-11
Original file line number
Diff line number
Diff line change
@@ -20,24 +20,24 @@ To release a new version of the project you need to follow the following steps:
20
20
21
21
The CI will automatically handle the build and create a draft GitHub release.
22
22
23
-
Once ready, you can edit and publish the draft release on GitHub. You will need to take the release notes and append them to the `CHANGELOG.md` file in the root of the repository.
23
+
Once ready, you can edit and publish the draft release on GitHub.
24
24
25
-
The list of changes from the CHANGELOG.md file 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:
25
+
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
26
27
-
1. Copy the previous release's page (i.e., V1-3.md) to the new release number. Change the version information and page weight in the file's frontmatter.
27
+
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.
28
28
2. Update the page title (Version x.x release notes) and add a few sentences about the main updates in the release.
29
-
3. Features and enhancements section with list of updates
30
-
4. (optional) Breaking changes section with a list of these changes and their impact (this section can also be used to update the [Upgrade page](https://grafana.com/docs/pyroscope/latest/upgrade-guide/)).
31
-
5. Bug fixes section with a list of updates.
32
-
6. Documentation updates section with a list of updates.
29
+
3.Add a Features and enhancements section with list of updates. Refer to previous release notes for examples.
30
+
4. (optional) Add a Breaking changes section with a list of these changes and their impact (this section can also be used to update the [Upgrade page](https://grafana.com/docs/pyroscope/latest/upgrade-guide/)).
31
+
5.Add a Bug fixes section with a list of updates.
32
+
6.Add a Documentation updates section with a list of updates.
33
33
34
-
For help writing release notes, refer to the [Writers' Toolkit](https://grafana.com/docs/writers-toolkit/write/).
34
+
For help writing release notes, refer to the [Writers' Toolkit](https://grafana.com/docs/writers-toolkit/write/).
35
35
36
36
Please do not delete GitHub releases that were once public.
37
37
38
-
To release a minor version simply merge fixes to the release branch then create and push a new tag. (e.g. `v0.x.1`)
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.
39
39
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).
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).
41
41
42
42
## Manual Release Process
43
43
@@ -66,4 +66,4 @@ make release
66
66
67
67
> Make sure to have a [GitHub Token](https://goreleaser.com/scm/github/?h=github#github)`GITHUB_TOKEN` correctly set.
68
68
69
-
Make sure to create the release notes and CHANGELOG for any manual release.
69
+
Make sure to create the release notes and CHANGELOG for any manual release.
0 commit comments