From ea76c76c9a672ece9e8534bad933a3660c3f8065 Mon Sep 17 00:00:00 2001 From: Ryan Yuan Date: Fri, 24 Jul 2026 10:12:33 +1000 Subject: [PATCH] docs: point v5 CHANGELOG at v4 branch instead of duplicating 4.x history The v5 CHANGELOG carried the full 4.0.0-4.6.0 release sections, which also live on the v4 branch. Maintaining them in two places drifts (the v4 branch is already at 4.7.0). Drop the duplicated 4.x sections and leave a pointer to the v4 branch CHANGELOG as the source of truth for the 4.x line. Signed-off-by: Ryan Yuan --- CHANGELOG.md | 249 +-------------------------------------------------- 1 file changed, 3 insertions(+), 246 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 71ee0759f..e815c049c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -306,246 +306,9 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Bump `github.com/aws/smithy-go` from v1.24.0 to v1.25.1 ([#831](https://github.com/opensearch-project/opensearch-go/pull/831)) - Bump `github.com/aws/aws-sdk-go-v2/config` from 1.32.6 to 1.32.7 ([#767](https://github.com/opensearch-project/opensearch-go/pull/767)) -## [4.6.0] +## [4.x] -### Dependencies - -- Bump `github.com/aws/aws-sdk-go-v2/config` from 1.29.14 to 1.32.5 ([#707](https://github.com/opensearch-project/opensearch-go/pull/707), [#711](https://github.com/opensearch-project/opensearch-go/pull/711), [#719](https://github.com/opensearch-project/opensearch-go/pull/719), [#730](https://github.com/opensearch-project/opensearch-go/pull/730), [#737](https://github.com/opensearch-project/opensearch-go/pull/737), [#761](https://github.com/opensearch-project/opensearch-go/pull/761)) -- Bump `github.com/aws/aws-sdk-go-v2` from 1.36.4 to 1.41.0 ([#710](https://github.com/opensearch-project/opensearch-go/pull/710), [#720](https://github.com/opensearch-project/opensearch-go/pull/720), [#759](https://github.com/opensearch-project/opensearch-go/pull/759)) -- Bump `github.com/stretchr/testify` from 1.10.0 to 1.11.1 ([#728](https://github.com/opensearch-project/opensearch-go/pull/728)) -- Bump `github.com/aws/aws-sdk-go` from 1.55.7 to 1.55.8 ([#716](https://github.com/opensearch-project/opensearch-go/pull/716)) -- Bump go version from 1.24.0 to 1.25.9 in order to resolve certain CVEs. Details in the Pull Request ([#825](https://github.com/opensearch-project/opensearch-go/pull/825)) - -### Added - -- Adds new fields for Opensearch 3.0 ([#702](https://github.com/opensearch-project/opensearch-go/pull/702)) -- Allow users to override signing port ([#721](https://github.com/opensearch-project/opensearch-go/pull/721)) -- Add `phase_took` features supported from OpenSearch 2.12 ([#722](https://github.com/opensearch-project/opensearch-go/pull/722)) -- Adds the action to refresh the search analyzers to the ISM plugin ([#686](https://github.com/opensearch-project/opensearch-go/pull/686)) - -### Changed - -- Test against Opensearch 3.0 ([#702](https://github.com/opensearch-project/opensearch-go/pull/702)) -- Add more SuggestOptions to SearchResp ([#713](https://github.com/opensearch-project/opensearch-go/pull/713)) -- Updates Go version to 1.24 ([#674](https://github.com/opensearch-project/opensearch-go/pull/674)) -- Replace `golang.org/x/exp/slices` usage with built-in `slices` ([#674](https://github.com/opensearch-project/opensearch-go/pull/674)) -- Update golangci-linter to 1.64.8 ([#740](https://github.com/opensearch-project/opensearch-go/pull/740)) -- Change MaxScore to pointer ([#740](https://github.com/opensearch-project/opensearch-go/pull/740)) -- Update workflow action ([#760](https://github.com/opensearch-project/opensearch-go/pull/760)) -- Migrate to golangci-lint v2 ([#760](https://github.com/opensearch-project/opensearch-go/pull/760)) - -### Deprecated - -### Removed - -### Fixed - -- Missing "caused by" information in StructError ([#752](https://github.com/opensearch-project/opensearch-go/pull/752)) -- Add missing `ignore_unavailable`, `allow_no_indices`, and `expand_wildcards` params to MSearch ([#757](https://github.com/opensearch-project/opensearch-go/pull/757)) -- Fix `UpdateResp` to correctly parse the `get` field when `_source` is requested in update operations. ([#739](https://github.com/opensearch-project/opensearch-go/pull/739)) - -### Security - -## [4.5.0] - -### Dependencies - -- Bump `github.com/aws/aws-sdk-go-v2/config` from 1.29.6 to 1.29.14 ([#692](https://github.com/opensearch-project/opensearch-go/pull/692)) -- Bump `github.com/aws/aws-sdk-go` from 1.55.6 to 1.55.7 ([#696](https://github.com/opensearch-project/opensearch-go/pull/696)) -- Bump `github.com/wI2L/jsondiff` from 0.6.1 to 0.7.0 ([#700](https://github.com/opensearch-project/opensearch-go/pull/700)) - -### Added - -- Adds DataStream field to IndicesGetResp struct ([#701](https://github.com/opensearch-project/opensearch-go/pull/701)) -- Adds `InnerHits` field to `SearchResp` ([#672](https://github.com/opensearch-project/opensearch-go/pull/672)) -- Adds `FilterPath` param ([#673](https://github.com/opensearch-project/opensearch-go/pull/673)) -- Adds `Aggregations` field to `MSearchResp` ([#690](https://github.com/opensearch-project/opensearch-go/pull/690)) - -### Changed - -- Bump golang version to 1.22 ([#691](https://github.com/opensearch-project/opensearch-go/pull/691)) -- Change ChangeCatRecoveryItemResp Byte fields from int to string ([#691](https://github.com/opensearch-project/opensearch-go/pull/691)) -- Changed log formatted examples code ([#694](https://github.com/opensearch-project/opensearch-go/pull/694)) -- Improve the error reporting of invalid body response ([#699](https://github.com/opensearch-project/opensearch-go/pull/699)) - -### Deprecated - -### Removed - -### Fixed - -### Security - -## [4.4.0] - -### Added - -- Adds `Highlight` field to `SearchHit` ([#654](https://github.com/opensearch-project/opensearch-go/pull/654)) -- Adds `MatchedQueries` field to `SearchHit` ([#663](https://github.com/opensearch-project/opensearch-go/pull/663)) -- Adds support for Opensearch 2.19 ([#668](https://github.com/opensearch-project/opensearch-go/pull/668)) - -### Changed - -### Deprecated - -### Removed - -### Fixed - -### Security - -### Dependencies - -- Bump `github.com/aws/aws-sdk-go` from 1.55.5 to 1.55.6 ([#657](https://github.com/opensearch-project/opensearch-go/pull/657)) -- Bump `github.com/wI2L/jsondiff` from 0.6.0 to 0.6.1 ([#643](https://github.com/opensearch-project/opensearch-go/pull/643)) -- Bump `github.com/aws/aws-sdk-go-v2` from 1.32.2 to 1.36.1 ([#664](https://github.com/opensearch-project/opensearch-go/pull/664)) -- Bump `github.com/stretchr/testify` from 1.9.0 to 1.10.0 ([#644](https://github.com/opensearch-project/opensearch-go/pull/644)) -- Bump `github.com/aws/aws-sdk-go-v2/config` from 1.27.43 to 1.29.6 ([#665](https://github.com/opensearch-project/opensearch-go/pull/665)) - -## [4.3.0] - -### Added - -- Adds ISM Alias action ([#615](https://github.com/opensearch-project/opensearch-go/pull/615)) -- Adds support for opensearch 2.17 ([#623](https://github.com/opensearch-project/opensearch-go/pull/623)) - -### Changed - -### Deprecated - -### Removed - -### Fixed - -- Fix ISM Transition to omitempty Conditions field ([#609](https://github.com/opensearch-project/opensearch-go/pull/609)) -- Fix ISM Allocation field types ([#609](https://github.com/opensearch-project/opensearch-go/pull/609)) -- Fix ISM Error Notification types ([#612](https://github.com/opensearch-project/opensearch-go/pull/612)) -- Fix signer receiving drained body on retries ([#620](https://github.com/opensearch-project/opensearch-go/pull/620)) -- Fix Bulk Index Items not executing failure callbacks on bulk request failure ([#626](https://github.com/opensearch-project/opensearch-go/issues/626)) - -### Security - -### Dependencies - -- Bump `github.com/aws/aws-sdk-go-v2/config` from 1.27.31 to 1.27.43 ([#611](https://github.com/opensearch-project/opensearch-go/pull/611), [#630](https://github.com/opensearch-project/opensearch-go/pull/630), [#632](https://github.com/opensearch-project/opensearch-go/pull/632)) -- Bump `github.com/aws/aws-sdk-go-v2` from 1.32.1 to 1.32.2 ([#631](https://github.com/opensearch-project/opensearch-go/pull/631)) - -## [4.2.0] - -### Dependencies - -- Bump `github.com/aws/aws-sdk-go-v2/config` from 1.27.23 to 1.27.31 ([#584](https://github.com/opensearch-project/opensearch-go/pull/584), [#588](https://github.com/opensearch-project/opensearch-go/pull/588), [#593](https://github.com/opensearch-project/opensearch-go/pull/593), [#605](https://github.com/opensearch-project/opensearch-go/pull/605)) -- Bump `github.com/aws/aws-sdk-go` from 1.54.12 to 1.55.5 ([#583](https://github.com/opensearch-project/opensearch-go/pull/583), [#590](https://github.com/opensearch-project/opensearch-go/pull/590), [#595](https://github.com/opensearch-project/opensearch-go/pull/595), [#596](https://github.com/opensearch-project/opensearch-go/pull/596)) - -### Added - -- Adds `Suggest` to `SearchResp` ([#602](https://github.com/opensearch-project/opensearch-go/pull/602)) -- Adds `MaxScore` to `ScrollGetResp` ([#607](https://github.com/opensearch-project/opensearch-go/pull/607)) - -### Changed - -- Split SnapshotGetResp into sub structs ([#603](https://github.com/opensearch-project/opensearch-go/pull/603)) - -### Deprecated - -### Removed - -- Remove workflow tests against gotip ([#604](https://github.com/opensearch-project/opensearch-go/pull/604)) - -### Fixed - -### Security - -## [4.1.0] - -### Added - -- Adds the `Routing` field in SearchHit interface. ([#516](https://github.com/opensearch-project/opensearch-go/pull/516)) -- Adds the `SearchPipelines` field to `SearchParams` ([#532](https://github.com/opensearch-project/opensearch-go/pull/532)) -- Adds support for OpenSearch 2.14 ([#552](https://github.com/opensearch-project/opensearch-go/pull/552)) -- Adds the `Caches` field to Node stats ([#572](https://github.com/opensearch-project/opensearch-go/pull/572)) -- Adds the `SeqNo` and `PrimaryTerm` fields in `SearchHit` ([#574](https://github.com/opensearch-project/opensearch-go/pull/574)) -- Adds guide on configuring the client with retry and backoff ([#540](https://github.com/opensearch-project/opensearch-go/pull/540)) -- Adds OpenSearch 2.15 to compatibility workflow test ([#575](https://github.com/opensearch-project/opensearch-go/pull/575)) - -### Changed - -- Security roles get response struct has its own sub structs without omitempty ([#572](https://github.com/opensearch-project/opensearch-go/pull/572)) - -### Deprecated - -### Removed - -### Fixed - -- Fixes empty request body on retry with compression enabled ([#543](https://github.com/opensearch-project/opensearch-go/pull/543)) -- Fixes `Conditions` in `PolicyStateTransition` of ISM plugin ([#556](https://github.com/opensearch-project/opensearch-go/pull/556)) -- Fixes integration test response validation when response is null ([#572](https://github.com/opensearch-project/opensearch-go/pull/572)) -- Adjust security Role struct for FLS from string to []string ([#572](https://github.com/opensearch-project/opensearch-go/pull/572)) -- Fixes wrong response parsing for indices mapping and recovery ([#572](https://github.com/opensearch-project/opensearch-go/pull/572)) -- Fixes wrong response parsing for security get requests ([#572](https://github.com/opensearch-project/opensearch-go/pull/572)) -- Fixes opensearchtransport ignores request context cancellation when `retryBackoff` is configured ([#540](https://github.com/opensearch-project/opensearch-go/pull/540)) -- Fixes opensearchtransport sleeps unexpectedly after the last retry ([#540](https://github.com/opensearch-project/opensearch-go/pull/540)) -- Improves ParseError response when server response is an unknown json ([#592](https://github.com/opensearch-project/opensearch-go/pull/592)) - -### Security - -### Dependencies - -- Bump `github.com/aws/aws-sdk-go` from 1.51.21 to 1.54.12 ([#534](https://github.com/opensearch-project/opensearch-go/pull/534), [#537](https://github.com/opensearch-project/opensearch-go/pull/537), [#538](https://github.com/opensearch-project/opensearch-go/pull/538), [#545](https://github.com/opensearch-project/opensearch-go/pull/545), [#554](https://github.com/opensearch-project/opensearch-go/pull/554), [#557](https://github.com/opensearch-project/opensearch-go/pull/557), [#563](https://github.com/opensearch-project/opensearch-go/pull/563), [#564](https://github.com/opensearch-project/opensearch-go/pull/564), [#570](https://github.com/opensearch-project/opensearch-go/pull/570), [#579](https://github.com/opensearch-project/opensearch-go/pull/579)) -- Bump `github.com/wI2L/jsondiff` from 0.5.1 to 0.6.0 ([#535](https://github.com/opensearch-project/opensearch-go/pull/535), [#566](https://github.com/opensearch-project/opensearch-go/pull/566)) -- Bump `github.com/aws/aws-sdk-go-v2/config` from 1.27.11 to 1.27.23 ([#546](https://github.com/opensearch-project/opensearch-go/pull/546), [#553](https://github.com/opensearch-project/opensearch-go/pull/553), [#558](https://github.com/opensearch-project/opensearch-go/pull/558), [#562](https://github.com/opensearch-project/opensearch-go/pull/562), [#567](https://github.com/opensearch-project/opensearch-go/pull/567), [#571](https://github.com/opensearch-project/opensearch-go/pull/571), [#577](https://github.com/opensearch-project/opensearch-go/pull/577)) -- Bump `github.com/aws/aws-sdk-go-v2` from 1.27.0 to 1.30.1 ([#559](https://github.com/opensearch-project/opensearch-go/pull/559), [#578](https://github.com/opensearch-project/opensearch-go/pull/578)) - -## [4.0.0] - -### Added - -- Adds GlobalIOUsage struct for nodes stats ([#506](https://github.com/opensearch-project/opensearch-go/pull/506)) -- Adds the `Explanation` field containing the document explain details to the `SearchHit` struct. ([#504](https://github.com/opensearch-project/opensearch-go/pull/504)) -- Adds new error types ([#512](https://github.com/opensearch-project/opensearch-go/pull/506)) -- Adds handling of non json errors to ParseError ([#512](https://github.com/opensearch-project/opensearch-go/pull/506)) -- Adds the `Failures` field to opensearchapi structs ([#510](https://github.com/opensearch-project/opensearch-go/pull/510)) -- Adds the `Fields` field containing the document fields to the `SearchHit` struct. ([#508](https://github.com/opensearch-project/opensearch-go/pull/508)) -- Adds security plugin ([#507](https://github.com/opensearch-project/opensearch-go/pull/507)) -- Adds security settings to container for security testing ([#507](https://github.com/opensearch-project/opensearch-go/pull/507)) -- Adds cluster.get-certs to copy admin certs out of the container ([#507](https://github.com/opensearch-project/opensearch-go/pull/507)) -- Adds the `Fields` field containing stored fields to the `DocumentGetResp` struct ([#526](https://github.com/opensearch-project/opensearch-go/pull/526)) -- Adds ism plugin ([#524](https://github.com/opensearch-project/opensearch-go/pull/524)) - -### Changed - -- Uses docker compose v2 instead of v1 ([#506](https://github.com/opensearch-project/opensearch-go/pull/506)) -- Updates go version to 1.21 ([#509](https://github.com/opensearch-project/opensearch-go/pull/509)) -- Moves Error structs from opensearchapi to opensearch package ([#512](https://github.com/opensearch-project/opensearch-go/pull/506)) -- Moves parseError function from opensearchapi to opensearch package as ParseError ([#512](https://github.com/opensearch-project/opensearch-go/pull/506)) -- Changes ParseError function to do type assertion to determine error type ([#512](https://github.com/opensearch-project/opensearch-go/pull/506)) -- Removes unused structs and functions from opensearch ([#517](https://github.com/opensearch-project/opensearch-go/pull/517)) -- Adjusts and extent opensearch tests for better coverage ([#517](https://github.com/opensearch-project/opensearch-go/pull/517)) -- Bumps codecov action version to v4 ([#517](https://github.com/opensearch-project/opensearch-go/pull/517)) -- Changes bulk error/reason field and some cat response fields to pointer as they can be nil ([#510](https://github.com/opensearch-project/opensearch-go/pull/510)) -- Adjust workflows to work with security plugin ([#507](https://github.com/opensearch-project/opensearch-go/pull/507)) -- Updates USER_GUIDE.md and add samples ([#518](https://github.com/opensearch-project/opensearch-go/pull/518)) -- Updates opensearchtransport.Client to use pooled gzip writer and buffer ([#521](https://github.com/opensearch-project/opensearch-go/pull/521)) -- Use go:build tags for testing ([#52?](https://github.com/opensearch-project/opensearch-go/pull/52?)) - -### Deprecated - -### Removed - -### Fixed - -- Fixes search request missing a slash when no indices are given ([#470](https://github.com/opensearch-project/opensearch-go/pull/469)) -- Fixes opensearchtransport check for nil response body ([#517](https://github.com/opensearch-project/opensearch-go/pull/517)) - -### Security - -### Dependencies - -- Bumps `github.com/aws/aws-sdk-go-v2` from 1.25.3 to 1.26.1 -- Bumps `github.com/wI2L/jsondiff` from 0.4.0 to 0.5.1 -- Bumps `github.com/aws/aws-sdk-go` from 1.50.36 to 1.51.21 -- Bumps `github.com/aws/aws-sdk-go-v2/config` from 1.27.7 to 1.27.11 +The 4.x release line is maintained on the [`v4`](https://github.com/opensearch-project/opensearch-go/blob/v4/CHANGELOG.md) branch. See its `CHANGELOG.md` for 4.0.0 through the latest 4.x release. ## [3.1.0] @@ -693,13 +456,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Bumps `github.com/aws/aws-sdk-go` from 1.44.45 to 1.44.132 [Unreleased]: https://github.com/opensearch-project/opensearch-go/compare/v4.6.0...HEAD -[4.6.0]: https://github.com/opensearch-project/opensearch-go/compare/v4.5.0...v4.6.0 -[4.5.0]: https://github.com/opensearch-project/opensearch-go/compare/v4.4.0...v4.5.0 -[4.4.0]: https://github.com/opensearch-project/opensearch-go/compare/v4.3.0...v4.4.0 -[4.3.0]: https://github.com/opensearch-project/opensearch-go/compare/v4.2.0...v4.3.0 -[4.2.0]: https://github.com/opensearch-project/opensearch-go/compare/v4.1.0...v4.2.0 -[4.1.0]: https://github.com/opensearch-project/opensearch-go/compare/v4.0.0...v4.1.0 -[4.0.0]: https://github.com/opensearch-project/opensearch-go/compare/v3.1.0...v4.0.0 +[4.x]: https://github.com/opensearch-project/opensearch-go/blob/v4/CHANGELOG.md [3.1.0]: https://github.com/opensearch-project/opensearch-go/compare/v3.0.0...v3.1.0 [3.0.0]: https://github.com/opensearch-project/opensearch-go/compare/v2.3.0...v3.0.0 [2.3.0]: https://github.com/opensearch-project/opensearch-go/compare/v2.2.0...v2.3.0