Add breaking changes to release notes #2936
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the release notes by adding a dedicated section for breaking changes and updating API information for clarity.
- Added a "Breaking changes" section with clear details on removed or replaced parameters and APIs.
- Updated the main release notes page layout to improve readability and navigation.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/release-notes/index.md | Added a new "Breaking changes" section and updated API and enhancements lists. |
| docs/release-notes/breaking-changes.md | Introduced detailed dropdown sections for breaking changes with mitigation actions. |
Comments suppressed due to low confidence (1)
docs/release-notes/index.md:29
- [nitpick] Consider hyperlinking 'breaking changes page' to the detailed documentation to enhance navigation.
See the breaking changes page for more details. 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
miguelgrinberg approved these changes Apr 18, 2025
marciw reviewed Apr 18, 2025
docs/release-notes/index.md Outdated
| * Add `index` to GeoShape field | ||
| * Add `search_inference_id` to SemanticText field | ||
| | ||
| ### Features and enhancements [elasticsearch-python-client-900-features-enhancements] |
There was a problem hiding this comment.
I would just delete the empty "Features and enhancements" and "Fixes" sections
Co-authored-by: Marci W <333176+marciw@users.noreply.github.com>
Co-authored-by: Marci W <333176+marciw@users.noreply.github.com>
Co-authored-by: Marci W <333176+marciw@users.noreply.github.com>
| Thanks Marci! LGTM. |
github-actions bot pushed a commit that referenced this pull request Apr 28, 2025
* Add breaking changes to release notes * Add upgrade tip * Update docs/release-notes/index.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix impact/action formatting * Fix links * Apply suggestions from code review Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> * Update docs/release-notes/breaking-changes.md Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> * Remove empty sections --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> (cherry picked from commit 185d90a)
pquentin added a commit that referenced this pull request Apr 28, 2025
* Add breaking changes to release notes * Add upgrade tip * Update docs/release-notes/index.md * Fix impact/action formatting * Fix links * Apply suggestions from code review * Apply suggestions from code review * Update docs/release-notes/breaking-changes.md * Remove empty sections --------- (cherry picked from commit 185d90a) Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Marci W <333176+marciw@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 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.
I also added sections to the main release notes page for easier readability.