Skip to content

publishing-a-release.md

Latest commit

 

History

History
25 lines (19 loc) · 1.9 KB

publishing-a-release.md

File metadata and controls

25 lines (19 loc) · 1.9 KB
Raw

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. 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 from develop -> master
  3. Run the Prepare Release workflow. a. Wait for this until the sync to master is completed.
  4. A new issue should appear in https://github.com/getsentry/publish/issues.
  5. 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.
  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: Update changelog for <fill in relevant version here> against develop branch.