Skip to content

Commit 5ff88d7

Browse files
committed
Sync open source content 🐝 (from 0534065be2ec37be9b4b981d38469b86bc372be4)
1 parent ce4af87 commit 5ff88d7

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/sdks/publish-sdk.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,3 +315,32 @@ For GitHub actions set up with `mode:pr`, the publishing dashboard highlights op
315315
}}
316316
/>
317317

318+
## Customizing GitHub release notes
319+
320+
When publishing SDKs, Speakeasy automatically generates release notes for GitHub releases based on generator changes. To customize these release notes or add release notes when no generator changes are detected, edit the `releaseNotes` property in the `gen.lock` file.
321+
322+
The `releaseNotes` property is used for generating GitHub release notes.
323+
324+
### Editing release notes
325+
326+
To customize release notes, add or edit the `releaseNotes` field in your `.speakeasy/gen.lock` file:
327+
328+
```yaml
329+
# .speakeasy/gen.lock
330+
lockVersion: 2.0.0
331+
id: abc123
332+
management:
333+
# ... other fields
334+
features:
335+
# ... feature flags
336+
releaseNotes: |
337+
## What's new
338+
- Added support for new authentication methods
339+
- Improved error handling for rate limits
340+
- Fixed pagination issues in list endpoints
341+
```
342+
343+
<Callout title="Tip">
344+
It's safe to edit the `releaseNotes` property before merging an auto-generated PR. The SDK generation workflow validates for changes before running, so your edits won't be overwritten during regeneration.
345+
</Callout>
346+

0 commit comments

Comments
 (0)