Repository navigation
release: 0.55.0 - #82
Conversation
| ### ⚠ BREAKING CHANGES | ||
|
|
||
| * **api:** sync OpenAPI spec from production | ||
|
|
||
| ### Features | ||
|
|
||
| * **api:** sync OpenAPI spec from production ([a492eb1](https://github.com/sentdm/sent-dm-python/commit/a492eb1a8a57db542be2045ac8a6be27d535cf50)) |
There was a problem hiding this comment.
🔴 Customers upgrading to 0.55.0 get a BREAKING CHANGES note that doesn't say what broke or what to do. The only line is "sync OpenAPI spec from production", an internal cause. CLAUDE.md asks for subjects that state "what changed, and what to do about it. Never an internal cause." This release removes SMSMarket.sender_value with no alias, so code reading it breaks with no warning. Fix: before merging, rewrite both 0.55.0 lines (CHANGELOG.md:8 and :12) and the release PR body. Name the removed sender_value field, its replacement in numbers, and the new payment-method requirement. A BEGIN_COMMIT_OVERRIDE in the PR body is one way to do it.
Why this was flagged
The changelog text is copied from the subject of commit a492eb1, feat(api)!: sync OpenAPI spec from production. CHANGELOG.md:8 and :12 both repeat that subject, so the BREAKING CHANGES section names no field, method or behaviour. Commit a492eb1 deletes sender_value: Optional[str] from src/sent_dm/types/channels/sms_market.py with no alias. A customer who reads market.sender_value gets an AttributeError after upgrading, and the release notes give no hint of the cause or the replacement (numbers). The same commit adds a payment-method requirement for call participants (payment_method_missing in src/sent_dm/types/voice/call.py), and the notes don't mention it either. Unlike the 0.54.0 entry, which spells out what changed, this one tells customers nothing they can act on. CLAUDE.md marks CHANGELOG.md as owned by release-please, but that only means rewriting it in a release PR is expected. It does not exempt the text from the rule about customer-readable subjects. I checked this by reading the diff and the commit; nothing was run.
Verification: CHANGELOG.md:8 (under "### ⚠ BREAKING CHANGES") and CHANGELOG.md:12 both say only "api: sync OpenAPI spec from production". The text names an internal process, not a customer-facing change. git show a492eb1 -- src/sent_dm/types/channels/sms_market.py deletes sender_value: Optional[str] = None from SMSMarket, and no alias remains.
|
🤖 Created releases: 🌻 |
Automated Release PR
0.55.0 (2026-11-12)
⚠ BREAKING CHANGES
sender_valueis no longer returned on an SMS market (channels.sms, and the SMS markets inside sender profile and channels responses). Read it from the market's numbers instead:numbers[].sender_value. Requests are unchanged:sender_valueis still accepted when creating an SMS channel or a sender profile.Features
This PR was generated with Release Please. See documentation.