Skip to content

Commit e061f61

Browse files
authoredJan 15, 2025
docs(release): Clarify descriptions for publishing prev. version (#15022)
1 parent 4ed0e69 commit e061f61

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed
 

‎docs/publishing-a-release.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,20 @@ _These steps are only relevant to Sentry employees when preparing and publishing
2222

2323
## Publishing a release for previous majors
2424

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

3840
## Updating the Changelog
3941

0 commit comments

Comments
 (0)