These steps are only relevant to Sentry employees when preparing and publishing a new SDK release.
If you want to release a new SDK for the first time, be sure to follow the New SDK Release Checklist
- Determine what version will be released (we use semver).
- Update
CHANGELOG.md
to add an entry for the next release number and a list of changes since the last release. (See details below.) a. Merging the Changelog PR will automatically trigger a sync fromdevelop
->master
- Run the Prepare Release workflow.
a. Wait for this until the sync to
master
is completed. - A new issue should appear in https://github.com/getsentry/publish/issues.
- Ask a member of the @getsentry/releases team to approve the release.
a. Once the release is completed, a sync from
master
->develop
will be automatically triggered
- Create a new branch.
- Run
yarn changelog
and copy everything - Create a new section in the changelog, deciding based on the changes whether it should be a minor bump or a patch release.
- Paste in the logs you copied earlier.
- Delete any which aren't user-facing changes.
- 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 finals
. If there are three or more, use an Oxford comma. (It's in the Sentry styleguide!) - Commit, push, and open a PR with the title
meta: Update changelog for <fill in relevant version here>
againstdevelop
branch.