|
2 | 2 |
|
3 | 3 | _These steps are only relevant to Sentry employees when preparing and publishing a new SDK release._ |
4 | 4 |
|
| 5 | +These have also been documented via [Cursor Rules](../.cursor/rules/publishing-release.mdc). |
| 6 | + |
5 | 7 | **If you want to release a new SDK for the first time, be sure to follow the |
6 | 8 | [New SDK Release Checklist](./new-sdk-release-checklist.md)** |
7 | 9 |
|
8 | 10 | 1. Run `yarn changelog` on the `develop` branch and determine what version will be released (we use |
9 | | - [semver](https://semver.org)) |
| 11 | + [semver](https://semver.org)). The semver version should be decided based on what is in included in the release. For example, if the release includes a new feature, we should increment the minor version. If it includes only bug fixes, we should increment the patch version. |
10 | 12 | 2. Create a branch `prepare-release/VERSION`, eg. `prepare-release/8.1.0`, off develop |
11 | 13 | 3. Update [`CHANGELOG.md`](https://github.com/getsentry/sentry-javascript/edit/master/CHANGELOG.md) to add an entry for |
12 | 14 | the next release number and a list of changes since the last release. (See details below.) |
@@ -43,13 +45,38 @@ _These steps are only relevant to Sentry employees when preparing and publishing |
43 | 45 | 2. Create a new section in the changelog with the previously determined version number. |
44 | 46 | 3. Paste in the logs you copied earlier. |
45 | 47 | 4. Delete any which aren't user-facing changes (such as docs or tests). |
46 | | -5. Highlight any important changes with subheadings. |
47 | | -6. If any of the PRs are from external contributors, include underneath the commits |
| 48 | +5. If there are any important features or fixes, highlight them under the `Important Changes` subheading. If there are no important changes, don't include this section. If the `Important Changes` subheading is used, put all other changes under the `Other Changes` subheading. |
| 49 | +6. Make sure the changelog entries are ordered alphabetically. |
| 50 | +7. If any of the PRs are from external contributors, include underneath the commits |
48 | 51 | `Work in this release contributed by <list of external contributors' GitHub usernames>. Thank you for your contributions!`. |
49 | 52 | If there's only one external PR, don't forget to remove the final `s`. If there are three or more, use an Oxford |
50 | 53 | comma. (It's in the Sentry styleguide!) |
51 | 54 | - We have a GitHub Action "External Contributors" which collects all external contributors in the changelog section |
52 | 55 | "Unreleased". The GitHub Action creates a PR with this change every time a PR of an external contributor is merged. |
53 | 56 | You can safely cut and paste this line to the new release section of the changelog (but a sanity check is never |
54 | 57 | wrong). |
55 | | -7. Commit, push, and continue with step 4 from the previous section with the general instructions (above). |
| 58 | +8. Commit, push, and continue with step 4 from the previous section with the general instructions (above). |
| 59 | + |
| 60 | +### Example Changelog Entry |
| 61 | + |
| 62 | +This is an example of a changelog entry for a release. |
| 63 | + |
| 64 | +```md |
| 65 | +## 9.28.0 |
| 66 | + |
| 67 | +### Important Changes |
| 68 | + |
| 69 | +- **feat(nestjs): Stop creating spans for `TracingInterceptor` ([#16501](https://github.com/getsentry/sentry-javascript/pull/16501))** |
| 70 | + |
| 71 | +With this change we stop creating spans for `TracingInterceptor` as this interceptor only serves as an internal helper and adds noise for the user. |
| 72 | + |
| 73 | +- **feat(node): Update vercel ai spans as per new conventions ([#16497](https://github.com/getsentry/sentry-javascript/pull/16497))** |
| 74 | + |
| 75 | +This feature ships updates to the span names and ops to better match OpenTelemetry. This should make them more easily accessible to the new agents module view we are building. |
| 76 | + |
| 77 | +### Other Changes |
| 78 | + |
| 79 | +- fix(sveltekit): Export `vercelAIIntegration` from `@sentry/node` ([#16496](https://github.com/getsentry/sentry-javascript/pull/16496)) |
| 80 | + |
| 81 | +Work in this release was contributed by @agrattan0820. Thank you for your contribution! |
| 82 | +``` |
0 commit comments