Document breaking-change changelog notes in provider docs skill#68738
Merged
shahar1 merged 1 commit intoJun 19, 2026
Merged
Conversation
The prepare-providers-documentation skill only told the agent to add a top-of-version note for the Airflow min-version bump case, so a release shipping a behavioural breaking change got the bullet but no explanation of what breaks or how to adapt. The repository changelog convention asks for exactly such an explanation whenever there is a breaking change, so make the skill require it for every breaking classification.
vincbeck
approved these changes
Jun 19, 2026
shahar1
changed the title
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.
Human Summary
While working on #68642, I've noticed that the skill didn't add notes on breaking changes (which are extremely important). This PR fixes it.
AI Summary
Click here
While preparing the 2026-06-16 provider documentation wave (#68642), two providers with breaking changes — `edge3` 4.0.0 (Edge execution-API `TaskInstanceDTO` schema change) and `common.ai` 0.5.0 (SQLToolset `allowed_tables` now enforced on queries) — got the `Breaking changes` bullet but no top-of-version `.. note::` explaining *what* breaks or *how* users should adapt.The cause is in the
prepare-providers-documentationskill: it instructedthe agent to add the
.. note::block only for the Airflow min-versionbump case. Yet every provider
changelog.rstcarries the standingconvention in its header — "only add notes … when there are some breaking
changes and you want to add an explanation to the users on how they are
supposed to deal with them" — so a behavioural breaking change should
always get an explanatory note.
This updates the skill (Phase 4b rules and the incremental Phase 4 step) so
the
.. note::block covers both situations: the Airflow min-version bumpand every
breakingclassification, with the breaking-change note writtenfrom the PR description and diff so readers learn how to react without
opening the PR.
Docs-only change to an agent skill; no runtime code affected.
Was generative AI tooling used to co-author this PR?
Generated-by: Claude Code (Opus 4.8) following the guidelines