Skip to content

docs(publish-release): Improve docs on release publishing #11672

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
Apr 18, 2024
Merged

docs(publish-release): Improve docs on release publishing #11672

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

## Updating the Changelog

Expand All @@ -29,4 +32,4 @@ _These steps are only relevant to Sentry employees when preparing and publishing
`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!)
8. Commit, push, and open a PR with the title `meta(changelog): Update changelog for VERSION` against `master` branch.
8. Commit, push, and continue with step 4 from the previous section with the general instructions (above).