Skip to content

Commit 2ea215d

Browse files
authored
chore(repo): Adjust "Publishing a Release" document to include internal changes section in changelog (#17374)
1 parent 56f0d7a commit 2ea215d

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/publishing-a-release.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ These have also been documented via [Cursor Rules](../.cursor/rules/publishing-r
4444
1. Run `yarn changelog` and copy everything.
4545
2. Create a new section in the changelog with the previously determined version number.
4646
3. Paste in the logs you copied earlier.
47-
4. Delete any which aren't user-facing changes (such as docs or tests).
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.
47+
4. 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 user-facing changes under the `Other Changes` subheading.
48+
5. Any changes that are purely internal (e.g. internal refactors (`ref`) without user-facing changes, tests, chores, etc) should be put under a `<details>` block, where the `<summary>` heading is "Internal Changes" (see example).
4949
6. Make sure the changelog entries are ordered alphabetically.
5050
7. If any of the PRs are from external contributors, include underneath the commits
5151
`Work in this release contributed by <list of external contributors' GitHub usernames>. Thank you for your contributions!`.
@@ -78,5 +78,13 @@ This feature ships updates to the span names and ops to better match OpenTelemet
7878

7979
- fix(sveltekit): Export `vercelAIIntegration` from `@sentry/node` ([#16496](https://github.com/getsentry/sentry-javascript/pull/16496))
8080

81+
<details>
82+
<summary> <strong>Internal Changes</strong> </summary>
83+
84+
- ref(node): Split up incoming & outgoing http handling ([#17358](https://github.com/getsentry/sentry-javascript/pull/17358))
85+
- test(node): Enable additionalDependencies in integration runner ([#17361](https://github.com/getsentry/sentry-javascript/pull/17361))
86+
87+
</details>
88+
8189
Work in this release was contributed by @agrattan0820. Thank you for your contribution!
8290
```

0 commit comments

Comments
 (0)