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/publishing-a-release.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -6,20 +6,20 @@ _These steps are only relevant to Sentry employees when preparing and publishing
6
6
**If you want to release a new SDK for the first time, be sure to follow the [New SDK Release Checklist](./new-sdk-release-checklist.md)**
7
7
8
8
1. Determine what version will be released (we use [semver](https://semver.org)).
9
-
2.Update [`CHANGELOG.md`](https://github.com/getsentry/sentry-javascript/edit/master/CHANGELOG.md) to add an entry for the next release number and a list of changes since the last release. (See details below.)
10
-
a. Merging the Changelog PR will automatically trigger a sync from `develop` -> `master`
11
-
3. Run the [Prepare Release](https://github.com/getsentry/sentry-javascript/actions/workflows/release.yml) workflow.
12
-
a. Wait for this until the sync to `master` is completed.
13
-
4. A new issue should appear in https://github.com/getsentry/publish/issues.
14
-
5. Ask a member of the [@getsentry/releases team](https://github.com/orgs/getsentry/teams/releases/members) to approve the release.
9
+
2.Create a branch `prepare-release/VERSION`, eg. `prepare-release/7.37.0`, off develop
10
+
3. Update [`CHANGELOG.md`](https://github.com/getsentry/sentry-javascript/edit/master/CHANGELOG.md) to add an entry for the next release number and a list of changes since the last release. (See details below.)
11
+
4. Create a PR towards `master` branch
12
+
5. When the PR is merged, it will automatically trigger the [Prepare Release](https://github.com/getsentry/sentry-javascript/actions/workflows/release.yml) on master.
13
+
6. A new issue should appear in https://github.com/getsentry/publish/issues.
14
+
7. Ask a member of the [@getsentry/releases team](https://github.com/orgs/getsentry/teams/releases/members) to approve the release.
15
15
a. Once the release is completed, a sync from `master` ->` develop` will be automatically triggered
16
16
17
17
## Updating the Changelog
18
18
19
-
1. Create a new branch.
19
+
1. Create a new branch`prepare-release/VERSION` off of `develop`, e.g. `prepare-release/7.37.1`.
20
20
2. Run `yarn changelog` and copy everything
21
21
3. Create a new section in the changelog, deciding based on the changes whether it should be a minor bump or a patch release.
22
22
4. Paste in the logs you copied earlier.
23
23
5. Delete any which aren't user-facing changes.
24
24
7. If any of the PRs are from external contributors, include underneath the commits `Work in this release contributed by <list of external contributors' GitHub usernames>. Thank you for your contributions!`. If there's only one external PR, don't forget to remove the final `s`. If there are three or more, use an Oxford comma. (It's in the Sentry styleguide!)
25
-
8. Commit, push, and open a PR with the title `meta: Update changelog for <fill in relevant version here>` against `develop` branch.
25
+
8. Commit, push, and open a PR with the title `meta(changelog): Update changelog for VERSION` against `master` branch.
0 commit comments