Skip to content

Latest commit

 

History

History
31 lines (26 loc) · 2 KB

publishing-a-release.md

File metadata and controls

31 lines (26 loc) · 2 KB

Publishing a Release

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

  1. Determine what version will be released (we use semver).
  2. Create a branch prepare-release/VERSION, eg. prepare-release/7.37.0, off develop
  3. Update 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 Prepare Release on master.
  6. A new issue should appear in https://github.com/getsentry/publish/issues.
  7. 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

Updating the Changelog

  1. Create a new branch prepare-release/VERSION off of develop, e.g. prepare-release/7.37.1.
  2. Run yarn changelog and copy everything
  3. Create a new section in the changelog, deciding based on the changes whether it should be a minor bump or a patch release.
  4. Paste in the logs you copied earlier.
  5. Delete any which aren't user-facing changes.
  6. 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!)
  7. Commit, push, and open a PR with the title meta(changelog): Update changelog for VERSION against master branch.