Skip to content

docs(release): Clarify descriptions for publishing prev. version #15022

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 15, 2025
Merged

docs(release): Clarify descriptions for publishing prev. version #15022

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/publishing-a-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,20 @@ _These steps are only relevant to Sentry employees when preparing and publishing

## Publishing a release for previous majors

1. Run `yarn changelog` on the major branch (e.g. `v8`) and determine what version will be released (we use
1. Run `yarn changelog` on a previous major branch (e.g. `v8`) and determine what version will be released (we use
[semver](https://semver.org))
2. Create a branch, e.g. `changelog-8.45.1`, off the major branch (e.g. `v8`)
2. Create a branch, e.g. `changelog-8.45.1`, off a previous major branch (e.g. `v8`)
3. Update `CHANGELOG.md` to add an entry for the next release number and a list of changes since the
last release. (See details below.)
4. Open a PR with the title `meta(changelog): Update changelog for VERSION` against the major branch.
5. Once the PR is merged, open the [Prepare Release workflow](https://github.com/getsentry/sentry-javascript/actions/workflows/release.yml) and
4. Open a PR with the title `meta(changelog): Update changelog for VERSION` against the previous major branch (e.g. `v8`).
5. **Be cautious!** The PR against the previous major branch should be merged via "Squash and Merge"
(as the commits already exist on this branch).
6. Once the PR is merged, open the [Prepare Release workflow](https://github.com/getsentry/sentry-javascript/actions/workflows/release.yml) and
fill in ![run-release-workflow.png](./assets/run-release-workflow.png)
1. The major branch you want to release for, e.g. `v8`
2. The version you want to release, e.g. `8.45.1`
3. The major branch to merge into, e.g. `v8`
6. Run the release workflow
7. Run the release workflow

## Updating the Changelog

Expand Down
Loading