Add changelog-entry quality rules to provider-doc release skill#70258
Open
shahar1 wants to merge 1 commit into
Open
Add changelog-entry quality rules to provider-doc release skill#70258shahar1 wants to merge 1 commit into
shahar1 wants to merge 1 commit into
Conversation
Three defects slipped through a real provider-release wave and were caught only in review: an add-then-rename feature split across two PRs in the same wave was listed as two disconnected changelog entries (with no reference to the introducing PR), entries that kept a contributor's lowercase subject, and no-PR release-tooling commits surfaced as user-facing changelog lines. Encode the fixes as Phase 4b entry rules plus a Phase 5 scan so future waves render a changelog that reads as what shipped.
vincbeck
approved these changes
Jul 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three changelog-entry defects slipped through a real provider-release wave prepared with the
prepare-providers-documentationskill and were only caught in maintainer review. This adds the rules that would have prevented them.Collapse within-wave "add then rename/rework" chains into one net entry. The Kafka provider added a listener (Add a DagRun and TaskInstance event listener under the Kafka provider #68082) and renamed it to the Kafka Event Producer (Rename Kafka Listener to Kafka Event Producer and update the documentation #70014) in the same unreleased wave. Following "one commit subject per entry" produced two disconnected lines —
Add ... event listener (#68082)under Features andRename Kafka Listener to Kafka Event Producer (#70014)under Misc — so a reader can't tell the net change is "a Kafka Event Producer was introduced," and the introducing PR is decoupled from the rename. The rule now writes one entry describing the net change and naming all involved PRs. This is the changelog counterpart of the already-merged unreleased-feature classification rule.Capitalize every entry's first letter, not only after stripping a Conventional Commit prefix (contributors ship lowercase subjects like
derive keycloak ...).Send no-PR release-tooling commits to the excluded block even when breeze's deterministic classifier labeled them
documentation(Prepare ... release,Hide non-user-facing entries ...) — a(#NNNN)-less line in a visible section reads as a mistake.Plus a Phase 5 scan that greps the new sections for all three defects before hand-off.
Docs/skill-only change — no runtime behavior affected.
Was generative AI tooling used to co-author this PR?
Generated-by: Claude Code (Opus 4.8, 1M context) following the guidelines