8000 docs(publish-release): Improve docs on release publishing (#11672) · mcous/sentry-javascript@30aa211 · GitHub
[go: up one dir, main page]

Skip to content

Commit 30aa211

Browse files
authored
docs(publish-release): Improve docs on release publishing (getsentry#11672)
1 parent f543033 commit 30aa211

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/publishing-a-release.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,15 @@ _These steps are only relevant to Sentry employees when preparing and publishing
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.)
12-
4. Create a PR towards `master` branch
13-
5. When the PR is merged, it will automatically trigger the
12+
4. Open a PR with the title `meta(changelog): Update changelog for VERSION` against `master` branch.
13+
5. **Be cautious!** The PR against `master` should be merged via "Merge Commit"
14+
6. When the PR is merged, it will automatically trigger the
1415
[Prepare Release](https://github.com/getsentry/sentry-javascript/actions/workflows/release.yml) on master.
15-
6. A new issue should appear in https://github.com/getsentry/publish/issues.
16-
7. Ask a member of the [@getsentry/releases team](https://github.com/orgs/getsentry/teams/releases/members) to approve
17-
the release. a. Once the release is completed, a sync from `master` ->` develop` will be automatically triggered
16+
7. A new issue should appear in https://github.com/getsentry/publish/issues.
17+
8. Wait until the CI check runs have finished successfully (there is a link to them in the issue).
18+
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
20+
the release is completed, a sync from `master` ->` develop` will be automatically triggered
1821

1922
## Updating the Changelog
2023

@@ -29,4 +32,4 @@ _These steps are only relevant to Sentry employees when preparing and publishing
2932
`Work in this release contributed by <list of external contributors' GitHub usernames>. Thank you for your contributions!`.
3033
If there's only one external PR, don't forget to remove the final `s`. If there are three or more, use an Oxford
3134
comma. (It's in the Sentry styleguide!)
32-
8. Commit, push, and open a PR with the title `meta(changelog): Update changelog for VERSION` against `master` branch.
35+
8. Commit, push, and continue with step 4 from the previous section with the general instructions (above).

0 commit comments

Comments
 (0)
0