Skip to content

Commit 45bae59

Browse files
fix: add rule to omit doc-only changes from release notes
The release skill was inconsistently surfacing doc-comment-only changes (e.g. Terraform description additions, docstring wording updates) as user-facing features in some releases but not others. This led to different release note content between Go and Python SDKs for the same underlying config changes. Add an explicit filter rule to Part 1 generation: skip changes that only modify comments/docstrings/descriptions with no API behavioral change.
1 parent 9b2f4a4 commit 45bae59

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

.agents/skills/release/SKILL.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,12 @@ We're excited to announce version {VERSION}!
153153
changes. Skip noise.
154154
- **Omit `codegen metadata` and `aggregated API specs update`** entries unless
155155
they introduce a specific user-visible change visible in the diff.
156+
- **Omit doc-only changes** — if a diff only updates comments, docstrings, or
157+
descriptions (e.g., `"IPv4"``"IPv4 or IPv6"` in a docstring, or adding a
158+
description to a service/resource for Terraform enablement) with no API
159+
behavioral change (no new fields, methods, types, or changed signatures),
160+
do **not** surface it in Part 1. These are internal metadata updates, not
161+
user-facing SDK changes.
156162

157163
Display the generated Part 1 to the user. Ask if they want to edit or approve.
158164

0 commit comments

Comments
 (0)