Skip to content

Commit f590083

Browse files
committed
fix(docs): Reorder how to determine version numbers for releases
1 parent 42e9b23 commit f590083

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

docs/publishing-a-release.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ _These steps are only relevant to Sentry employees when preparing and publishing
55
**If you want to release a new SDK for the first time, be sure to follow the
66
[New SDK Release Checklist](./new-sdk-release-checklist.md)**
77

8-
1. Determine what version will be released (we use [semver](https://semver.org)).
8+
1. Run `yarn changelog` on the `develop` branch and determine what version will be released (we use [semver](https://semver.org))
99
2. Create a branch `prepare-release/VERSION`, eg. `prepare-release/7.37.0`, off develop
1010
3. Update [`CHANGELOG.md`](https://github.com/getsentry/sentry-javascript/edit/master/CHANGELOG.md) to add an entry for
1111
the next release number and a list of changes since the last release. (See details below.)
@@ -16,20 +16,18 @@ _These steps are only relevant to Sentry employees when preparing and publishing
1616
7. A new issue should appear in https://github.com/getsentry/publish/issues.
1717
8. Wait until the CI check runs have finished successfully (there is a link to them in the issue).
1818
9. Once CI passes successfully, ask a member of the
19-
[@getsentry/releases team](https://github.com/orgs/getsentry/teams/releases/members) to approve the release. a. Once
19+
[@getsentry/releases-approvers](https://github.com/orgs/getsentry/teams/release-approvers) to approve the release. a. Once
2020
the release is completed, a sync from `master` ->` develop` will be automatically triggered
2121

2222
## Updating the Changelog
2323

24-
1. Create a new branch `prepare-release/VERSION` off of `develop`, e.g. `prepare-release/7.37.1`.
25-
2. Run `yarn changelog` and copy everything
26-
3. Create a new section in the changelog, deciding based on the changes whether it should be a minor bump or a patch
27-
release.
28-
4. Paste in the logs you copied earlier.
29-
5. Delete any which aren't user-facing changes (such as docs or tests).
30-
6. Highlight any important changes with subheadings.
31-
7. If any of the PRs are from external contributors, include underneath the commits
24+
1. Run `yarn changelog` and copy everything.
25+
2. Create a new section in the changelog with the previously determined version number.
26+
3. Paste in the logs you copied earlier.
27+
4. Delete any which aren't user-facing changes (such as docs or tests).
28+
5. Highlight any important changes with subheadings.
29+
6. If any of the PRs are from external contributors, include underneath the commits
3230
`Work in this release contributed by <list of external contributors' GitHub usernames>. Thank you for your contributions!`.
3331
If there's only one external PR, don't forget to remove the final `s`. If there are three or more, use an Oxford
3432
comma. (It's in the Sentry styleguide!)
35-
8. Commit, push, and continue with step 4 from the previous section with the general instructions (above).
33+
7. Commit, push, and continue with step 4 from the previous section with the general instructions (above).

0 commit comments

Comments
 (0)