Skip to content

Conversation

@andrross
Copy link
Member

@andrross andrross commented Dec 9, 2025

Check List

  • Functionality includes testing.
  • API changes companion pull request created, if applicable.
  • Public documentation issue/PR created, if applicable.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Summary by CodeRabbit

  • New Features

    • Release notes published for version 3.4.0 summarizing additions and updates.
  • Changed

    • Unreleased changelog link advanced to 3.4; prior "Added" entries for Unreleased 3.x were removed.
    • Performance and architectural adjustments documented, including builder-pattern guidance.
  • Bug Fixes

    • Stability and correctness improvements summarized across components (no runtime code changes).
  • Deprecated

    • Certain constructor patterns deprecated in favor of builder-style APIs.

✏️ Tip: You can customize this high-level summary in your review settings.

@andrross andrross requested a review from a team as a code owner December 9, 2025 23:59
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 9, 2025

Walkthrough

Removed "Added" entries from the Unreleased 3.x section in CHANGELOG.md, updated its Unreleased comparison link to reference 3.4, and added release-notes/opensearch.release-notes-3.4.0.md containing categorized release notes for version 3.4.0 (informational content only).

Changes

Cohort / File(s) Summary
Changelog
CHANGELOG.md
Removed all "Added" entries under Unreleased 3.x and updated the Unreleased comparison link from 3.3...main to 3.4...main. No functional changes.
Release Notes
release-notes/opensearch.release-notes-3.4.0.md
Added a new release notes document for version 3.4.0 with sections: Added, Changed, Fixed, Dependencies, Deprecated (informational content only).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Docs-only changes; review focus:
    • The Unreleased comparison URL in CHANGELOG.md.
    • Version heading and section structure in release-notes/opensearch.release-notes-3.4.0.md.

Poem

🐰 I hopped through lines to tidy the score,
Quieted additions, then opened a door,
Penned notes for three-dot-four with a twitch and a grin,
A nibble of clarity snugged neatly within,
Carrot crumbs of changelog left where I’d been. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is missing critical sections required by the template, including Description and Related Issues; it only contains the checklist and license confirmation. Add a 'Description' section explaining what this change achieves and a 'Related Issues' section to document any associated issue numbers.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Forward port 3.4 release notes to main' accurately summarizes the main change: moving 3.4 release notes from a release branch to the main branch.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 78edf4d and 221f78e.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (19)
  • GitHub Check: assemble (25, ubuntu-latest)
  • GitHub Check: assemble (25, ubuntu-24.04-arm)
  • GitHub Check: assemble (21, ubuntu-24.04-arm)
  • GitHub Check: assemble (21, ubuntu-latest)
  • GitHub Check: assemble (25, windows-latest)
  • GitHub Check: assemble (21, windows-latest)
  • GitHub Check: precommit (25, windows-latest)
  • GitHub Check: precommit (25, macos-15)
  • GitHub Check: precommit (25, macos-15-intel)
  • GitHub Check: precommit (21, macos-15)
  • GitHub Check: precommit (21, windows-2025, true)
  • GitHub Check: precommit (21, ubuntu-24.04-arm)
  • GitHub Check: precommit (21, macos-15-intel)
  • GitHub Check: precommit (25, ubuntu-latest)
  • GitHub Check: precommit (21, windows-latest)
  • GitHub Check: precommit (25, ubuntu-24.04-arm)
  • GitHub Check: precommit (21, ubuntu-latest)
  • GitHub Check: detect-breaking-change
  • GitHub Check: Analyze (java)

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
release-notes/opensearch.release-notes-3.4.0.md (1)

11-11: Use hyphens for compound adjectives "context-aware".

Lines 11 and 30 use "context aware" without hyphens. In compound adjectives modifying nouns, add hyphens:

- Add a mapper for context aware segments grouping criteria
+ Add a mapper for context-aware segments grouping criteria
- Add support for context aware segments
+ Add support for context-aware segments

Also applies to: 30-30

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ba9ec47 and bb15f84.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • release-notes/opensearch.release-notes-3.4.0.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
release-notes/opensearch.release-notes-3.4.0.md

[grammar] ~11-~11: Use a hyphen to join words.
Context: .../pull/19539)) - Add a mapper for context aware segments grouping criteria ([#1923...

(QB_NEW_EN_HYPHEN)


[uncategorized] ~13-~13: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...568)) - Add support for repository with Server side encryption enabled and client side encr...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[grammar] ~13-~13: Use a hyphen to join words.
Context: ...erver side encryption enabled and client side encryption as well based on a flag....

(QB_NEW_EN_HYPHEN)


[uncategorized] ~30-~30: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...enSearch/pull/19878)) - Add support for context aware segments ([#19098](https://github.com/o...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[style] ~52-~52: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ontroller with org.opensearch.secure_sm.AccessController in discovery plugins ([#19802](https://...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~60-~60: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....Stats and RemoteSegmentTransferTracker.Stats class to use the Builder pattern instea...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[uncategorized] ~118-~118: The official name of this software platform is spelled with a capital “H”.
Context: ...-project/OpenSearch/pull/19692)) - Bump com.github.spotbugs:spotbugs-annotations from 4.9...

(GITHUB)


[uncategorized] ~121-~121: The official name of this software platform is spelled with a capital “H”.
Context: ...-project/OpenSearch/pull/19763)) - Bump github/codeql-action from 3 to 4 ([#19785](ht...

(GITHUB)


[style] ~148-~148: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....Stats and DirectoryFileTransferTracker.Stats in favor of the new Builder ([#19862](h...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~149-~149: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....Stats and RemoteSegmentTransferTracker.Stats in favor of the new Builder ([#19837](h...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🪛 markdownlint-cli2 (0.18.1)
release-notes/opensearch.release-notes-3.4.0.md

85-85: Bare URL used

(MD034, no-bare-urls)


87-87: Bare URL used

(MD034, no-bare-urls)


89-89: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (19)
  • GitHub Check: precommit (21, windows-2025, true)
  • GitHub Check: precommit (25, macos-15)
  • GitHub Check: precommit (25, windows-latest)
  • GitHub Check: precommit (25, macos-15-intel)
  • GitHub Check: precommit (25, ubuntu-24.04-arm)
  • GitHub Check: precommit (21, ubuntu-latest)
  • GitHub Check: precommit (21, macos-15)
  • GitHub Check: precommit (25, ubuntu-latest)
  • GitHub Check: precommit (21, macos-15-intel)
  • GitHub Check: precommit (21, ubuntu-24.04-arm)
  • GitHub Check: precommit (21, windows-latest)
  • GitHub Check: assemble (21, ubuntu-24.04-arm)
  • GitHub Check: assemble (25, windows-latest)
  • GitHub Check: assemble (25, ubuntu-24.04-arm)
  • GitHub Check: assemble (25, ubuntu-latest)
  • GitHub Check: assemble (21, windows-latest)
  • GitHub Check: assemble (21, ubuntu-latest)
  • GitHub Check: detect-breaking-change
  • GitHub Check: Analyze (java)
🔇 Additional comments (4)
CHANGELOG.md (1)

19-19: Version link correctly updated for forward-port.

The comparison link is properly updated from the 3.3 release to 3.4, aligning with the release notes forward-port.

release-notes/opensearch.release-notes-3.4.0.md (3)

54-54: Verify PR reference link in line 54.

Line 54 appears to have a mismatched PR reference. The comment text shows (#19752) but please verify the link destination matches the intended pull request.


105-141: Dependencies section looks good.

All dependency updates are properly documented with version changes and PR references.


143-156: Deprecation notices are clear and well-structured.

All deprecation entries consistently communicate the migration path to the Builder pattern, making it easy for maintainers to plan upgrades.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

♻️ Duplicate comments (1)
release-notes/opensearch.release-notes-3.4.0.md (1)

13-13: **** This issue was already flagged in a previous review comment. The malformed URL and hyphenation errors on this line have been identified and need the previously suggested fix applied.

🧹 Nitpick comments (2)
release-notes/opensearch.release-notes-3.4.0.md (2)

11-11: Hyphenate compound adjective.

When compound adjectives modify a following noun, use a hyphen to join the words.

- Add a mapper for context aware segments grouping criteria ([#19233](https://github.com/opensearch-project/OpenSearch/pull/19233))
+ Add a mapper for context-aware segments grouping criteria ([#19233](https://github.com/opensearch-project/OpenSearch/pull/19233))

30-30: Hyphenate compound adjective.

When compound adjectives modify a following noun, use a hyphen to join the words.

- Add support for context aware segments ([#19098](https://github.com/opensearch-project/OpenSearch/pull/19098))
+ Add support for context-aware segments ([#19098](https://github.com/opensearch-project/OpenSearch/pull/19098))
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2fa6834 and 580ff62.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • release-notes/opensearch.release-notes-3.4.0.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • CHANGELOG.md
🧰 Additional context used
🪛 LanguageTool
release-notes/opensearch.release-notes-3.4.0.md

[grammar] ~11-~11: Use a hyphen to join words.
Context: .../pull/19539)) - Add a mapper for context aware segments grouping criteria ([#1923...

(QB_NEW_EN_HYPHEN)


[uncategorized] ~13-~13: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...568)) - Add support for repository with Server side encryption enabled and client side encr...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[grammar] ~13-~13: Use a hyphen to join words.
Context: ...erver side encryption enabled and client side encryption as well based on a flag....

(QB_NEW_EN_HYPHEN)


[uncategorized] ~30-~30: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...enSearch/pull/19878)) - Add support for context aware segments ([#19098](https://github.com/o...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[style] ~53-~53: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ontroller with org.opensearch.secure_sm.AccessController in discovery plugins ([#19802](https://...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~61-~61: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....Stats and RemoteSegmentTransferTracker.Stats class to use the Builder pattern instea...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[uncategorized] ~119-~119: The official name of this software platform is spelled with a capital “H”.
Context: ...-project/OpenSearch/pull/19692)) - Bump com.github.spotbugs:spotbugs-annotations from 4.9...

(GITHUB)


[uncategorized] ~122-~122: The official name of this software platform is spelled with a capital “H”.
Context: ...-project/OpenSearch/pull/19763)) - Bump github/codeql-action from 3 to 4 ([#19785](ht...

(GITHUB)


[style] ~149-~149: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....Stats and DirectoryFileTransferTracker.Stats in favor of the new Builder ([#19862](h...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~150-~150: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....Stats and RemoteSegmentTransferTracker.Stats in favor of the new Builder ([#19837](h...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🪛 markdownlint-cli2 (0.18.1)
release-notes/opensearch.release-notes-3.4.0.md

86-86: Bare URL used

(MD034, no-bare-urls)


88-88: Bare URL used

(MD034, no-bare-urls)


90-90: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (20)
  • GitHub Check: precommit (21, ubuntu-latest)
  • GitHub Check: precommit (25, macos-15)
  • GitHub Check: precommit (21, windows-2025, true)
  • GitHub Check: precommit (25, ubuntu-latest)
  • GitHub Check: precommit (25, windows-latest)
  • GitHub Check: precommit (25, ubuntu-24.04-arm)
  • GitHub Check: precommit (21, macos-15-intel)
  • GitHub Check: precommit (21, windows-latest)
  • GitHub Check: precommit (25, macos-15-intel)
  • GitHub Check: precommit (21, macos-15)
  • GitHub Check: precommit (21, ubuntu-24.04-arm)
  • GitHub Check: assemble (25, windows-latest)
  • GitHub Check: assemble (25, ubuntu-24.04-arm)
  • GitHub Check: assemble (25, ubuntu-latest)
  • GitHub Check: assemble (21, windows-latest)
  • GitHub Check: assemble (21, ubuntu-24.04-arm)
  • GitHub Check: assemble (21, ubuntu-latest)
  • GitHub Check: detect-breaking-change
  • GitHub Check: Analyze (java)
  • GitHub Check: Mend Security Check

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

♻️ Duplicate comments (3)
release-notes/opensearch.release-notes-3.4.0.md (3)

13-13: Fix compound adjective hyphenation in line 13.

Compound adjectives should be hyphenated when they modify a noun. Update "Server side" and "client side" to use hyphens.

Apply this diff:

- Add support for repository with Server side encryption enabled and client side encryption as well based on a flag. ([#19630](https://github.com/opensearch-project/OpenSearch/pull/19630))
+ Add support for repository with Server-side encryption enabled and client-side encryption as well based on a flag. ([#19630](https://github.com/opensearch-project/OpenSearch/pull/19630))

86-86: Fix malformed markdown link on line 86.

The PR reference syntax is broken with doubled parentheses and an extra closing parenthesis. Correct the markdown link format.

Apply this diff:

- Fix potential concurrent modification exception when updating allocation filters ([#19701])(https://github.com/opensearch-project/OpenSearch/pull/19701))
+ Fix potential concurrent modification exception when updating allocation filters ([#19701](https://github.com/opensearch-project/OpenSearch/pull/19701))

88-88: Fix malformed markdown link and add missing space on line 88.

The PR reference has doubled parentheses and an extra closing parenthesis. Also add a space between "number" and the PR reference.

Apply this diff:

- Fix file-based ingestion consumer to handle start point beyond max line number([#19757])(https://github.com/opensearch-project/OpenSearch/pull/19757))
+ Fix file-based ingestion consumer to handle start point beyond max line number ([#19757](https://github.com/opensearch-project/OpenSearch/pull/19757))
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a6dcd43 and 78edf4d.

📒 Files selected for processing (1)
  • release-notes/opensearch.release-notes-3.4.0.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
release-notes/opensearch.release-notes-3.4.0.md

[grammar] ~11-~11: Use a hyphen to join words.
Context: .../pull/19539)) - Add a mapper for context aware segments grouping criteria ([#1923...

(QB_NEW_EN_HYPHEN)


[uncategorized] ~13-~13: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...568)) - Add support for repository with Server side encryption enabled and client side encr...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[grammar] ~13-~13: Use a hyphen to join words.
Context: ...erver side encryption enabled and client side encryption as well based on a flag....

(QB_NEW_EN_HYPHEN)


[uncategorized] ~30-~30: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...enSearch/pull/19878)) - Add support for context aware segments ([#19098](https://github.com/o...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[style] ~53-~53: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ontroller with org.opensearch.secure_sm.AccessController in discovery plugins ([#19802](https://...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~61-~61: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....Stats and RemoteSegmentTransferTracker.Stats class to use the Builder pattern instea...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[uncategorized] ~119-~119: The official name of this software platform is spelled with a capital “H”.
Context: ...-project/OpenSearch/pull/19692)) - Bump com.github.spotbugs:spotbugs-annotations from 4.9...

(GITHUB)


[uncategorized] ~122-~122: The official name of this software platform is spelled with a capital “H”.
Context: ...-project/OpenSearch/pull/19763)) - Bump github/codeql-action from 3 to 4 ([#19785](ht...

(GITHUB)


[style] ~149-~149: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....Stats and DirectoryFileTransferTracker.Stats in favor of the new Builder ([#19862](h...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)


[style] ~150-~150: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....Stats and RemoteSegmentTransferTracker.Stats in favor of the new Builder ([#19837](h...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🪛 markdownlint-cli2 (0.18.1)
release-notes/opensearch.release-notes-3.4.0.md

86-86: Bare URL used

(MD034, no-bare-urls)


88-88: Bare URL used

(MD034, no-bare-urls)

@sandeshkr419 sandeshkr419 merged commit 66f28fb into opensearch-project:main Dec 10, 2025
41 checks passed
@andrross andrross deleted the 3.4-release-notes branch December 10, 2025 23:38
fdesu pushed a commit to fdesu/OpenSearch that referenced this pull request Dec 13, 2025
* Forward port 3.4 release notes to main

Signed-off-by: Andrew Ross <[email protected]>

* Fix formatting issues in release notes for 3.4.0

---------

Signed-off-by: Andrew Ross <[email protected]>
Signed-off-by: Sandesh Kumar <[email protected]>
Co-authored-by: Sandesh Kumar <[email protected]>
fdesu pushed a commit to fdesu/OpenSearch that referenced this pull request Dec 13, 2025
* Forward port 3.4 release notes to main

Signed-off-by: Andrew Ross <[email protected]>

* Fix formatting issues in release notes for 3.4.0

---------

Signed-off-by: Andrew Ross <[email protected]>
Signed-off-by: Sandesh Kumar <[email protected]>
Co-authored-by: Sandesh Kumar <[email protected]>
# Conflicts:
#	release-notes/opensearch.release-notes-3.4.0.md
liuguoqingfz pushed a commit to liuguoqingfz/OpenSearch that referenced this pull request Dec 15, 2025
* Forward port 3.4 release notes to main

Signed-off-by: Andrew Ross <[email protected]>

* Fix formatting issues in release notes for 3.4.0

---------

Signed-off-by: Andrew Ross <[email protected]>
Signed-off-by: Sandesh Kumar <[email protected]>
Co-authored-by: Sandesh Kumar <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants