Skip to content

Commit 40da652

Browse files
authored
Document how to publish a new release (#3361)
1 parent ce40962 commit 40da652

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,20 @@ Similar to building and testing, linting can be done in the project root or in i
5151

5252
Note: you must run `yarn build` before `yarn lint` will work.
5353

54-
## Final Notes
54+
## Considerations Before Sending Your First PR
5555

56-
When contributing to the codebase, please make note of the following:
56+
When contributing to the codebase, please note:
5757

5858
- Non-trivial PRs will not be accepted without tests (see above).
5959
- Please do not bump version numbers yourself.
6060
- [`raven-js`](https://github.com/getsentry/sentry-javascript/tree/3.x/packages/raven-js) and [`raven-node`](https://github.com/getsentry/sentry-javascript/tree/3.x/packages/raven-node) are deprecated, and only bug and security fix PRs will be accepted targeting the [3.x branch](https://github.com/getsentry/sentry-javascript/tree/3.x). Any new features and improvements should be to our new SDKs (`browser` and `node`) and the packages (`core`, `hub`, `integrations`, and the like) which support them.
61+
62+
## Publishing a Release
63+
64+
_These steps are only relevant to Sentry employees when preparing and publishing a new SDK release._
65+
66+
1. Determine what version will be released (we use [semver](https://semver.org)).
67+
2. Update [`CHANGELOG.md`](https://github.com/getsentry/sentry-javascript/edit/master/CHANGELOG.md) to add an entry to the next release number and a list of changes since the last release.
68+
3. Run the [Prepare Release](https://github.com/getsentry/sentry-javascript/actions/workflows/release.yml) workflow.
69+
4. A new issue should appear in https://github.com/getsentry/publish/issues.
70+
5. Ask a member of the [@getsentry/releases team](https://github.com/orgs/getsentry/teams/releases/members) to approve the release.

0 commit comments

Comments
 (0)