Skip to content

Commit

Permalink
Update RELEASE.md (#2948)
Browse files Browse the repository at this point in the history
* Update RELEASE.md

* Update RELEASE.md
  • Loading branch information
knylander-grafana authored Jan 19, 2024
1 parent 060f8bd commit a07d305
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions docs/internal/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,24 @@

To release a new version of the project you need to follow the following steps:

1. Create a new branch for the release (e.g. `release/v0.x`)
2. Create the tag for the release (e.g. `v0.x.0`)
1. Create a new branch for the release (e.g., `release/v0.x`)
2. Create the tag for the release (e.g., `v0.x.0`)
3. Push the release branch and tag to the remote

The ci will automatically handle the build and create a draft github release.
The CI will automatically handle the build and create a draft github release.

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

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:

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.
2. Update the page title (Version x.x release notes) and add a few sentences about the main updates in the release.
3. Features and enhancements section with list of updates
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/)).
5. Bug fixes section with a list of updates.
6. Documentation updates section with a list of updates.

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

Please do not delete GitHub releases that were once public.

Expand Down Expand Up @@ -44,3 +55,5 @@ make release
```

> Make sure to have a [Github Token](https://goreleaser.com/scm/github/?h=github#github) `GITHUB_TOKEN` correctly set.
Make sure to create the release notes and CHANGELOG for any manual release.

0 comments on commit a07d305

Please sign in to comment.