Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preparing for release, 4.0.0 #530

Merged
merged 3 commits into from
Apr 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

## [Unreleased]
## [4.0.0]

### Added
- Adds GlobalIOUsage struct for nodes stats ([#506](https://github.com/opensearch-project/opensearch-go/pull/506))
Expand All @@ -14,7 +14,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- 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 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
Expand Down Expand Up @@ -193,7 +193,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Bumps `github.com/stretchr/testify` from 1.8.0 to 1.8.1
- Bumps `github.com/aws/aws-sdk-go` from 1.44.45 to 1.44.132

[Unreleased]: https://github.com/opensearch-project/opensearch-go/compare/v3.1.0...HEAD
[4.0.0]: https://github.com/opensearch-project/opensearch-go/compare/v3.1.0...v4.0.0
[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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Go Reference](https://pkg.go.dev/badge/github.com/opensearch-project/opensearch-go.svg)](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v3) [![Build](https://github.com/opensearch-project/opensearch-go/actions/workflows/lint.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/lint.yml) [![Unit](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-unit.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-unit.yml) [![Integration](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-integration.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-integration.yml) [![codecov](https://codecov.io/gh/opensearch-project/opensearch-go/branch/main/graph/badge.svg?token=MI9g3KYHVx)](https://codecov.io/gh/opensearch-project/opensearch-go) [![Chat](https://img.shields.io/badge/chat-on%20forums-blue)](https://discuss.opendistrocommunity.dev/c/clients/) ![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)
[![Go Reference](https://pkg.go.dev/badge/github.com/opensearch-project/opensearch-go.svg)](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v4) [![Build](https://github.com/opensearch-project/opensearch-go/actions/workflows/lint.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/lint.yml) [![Unit](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-unit.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-unit.yml) [![Integration](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-integration.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-integration.yml) [![codecov](https://codecov.io/gh/opensearch-project/opensearch-go/branch/main/graph/badge.svg?token=MI9g3KYHVx)](https://codecov.io/gh/opensearch-project/opensearch-go) [![Chat](https://img.shields.io/badge/chat-on%20forums-blue)](https://discuss.opendistrocommunity.dev/c/clients/) ![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)

![OpenSearch logo](OpenSearch.svg)

Expand All @@ -20,7 +20,7 @@ OpenSearch Go Client
- [Developer Guide](DEVELOPER_GUIDE.md)
- [User Guide](USER_GUIDE.md)
- [Documentation](https://opensearch.org/docs/latest/clients/go/)
- [API Documentation](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v3)
- [API Documentation](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v4)
- Need help? Try [Forums](https://discuss.opendistrocommunity.dev/c/clients/)
- [Project Principles](https://opensearch.org/#principles)
- [Contributing to OpenSearch](CONTRIBUTING.md)
Expand Down
4 changes: 2 additions & 2 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Repositories create consistent release labels, such as `v1.0.0`, `v1.1.0` and `v
The release process is standard across repositories in this org and is run by a release manager volunteering from amongst [MAINTAINERS](MAINTAINERS.md).

1. Ensure that the version in [version.go](internal/version/version.go) is correct for the next release.
2. For major version releases, ensure that all references are up-to-date, e.g. `github.com/opensearch-project/opensearch-go/v3`, see [opensearch-go#444](https://github.com/opensearch-project/opensearch-go/pull/444).
2. For major version releases, ensure that all references are up-to-date, e.g. `github.com/opensearch-project/opensearch-go/v4`, see [opensearch-go#444](https://github.com/opensearch-project/opensearch-go/pull/444).
3. Edit the [CHANGELOG](CHANGELOG.md) and replace the `Unreleased` section with the version about to be released.
4. Add a comparison link to the new version at the bottom of the [CHANGELOG](CHANGELOG.md).
5. Create a pull request with the changes into `main`, e.g. [opensearch-go#443](https://github.com/opensearch-project/opensearch-go/pull/443).
Expand All @@ -57,4 +57,4 @@ The release process is standard across repositories in this org and is run by a
### Security

### Dependencies
```
```
18 changes: 9 additions & 9 deletions USER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v3/opensearchutil"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4/opensearchutil"
)

const IndexName = "go-test-index1"
Expand Down Expand Up @@ -227,10 +227,10 @@ import (
"os"

"github.com/aws/aws-sdk-go/aws/session"
requestsigner "github.com/opensearch-project/opensearch-go/v3/signer/aws"
requestsigner "github.com/opensearch-project/opensearch-go/v4/signer/aws"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

const IndexName = "go-test-index1"
Expand Down Expand Up @@ -296,9 +296,9 @@ import (
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/config"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
requestsigner "github.com/opensearch-project/opensearch-go/v3/signer/awsv2"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
requestsigner "github.com/opensearch-project/opensearch-go/v4/signer/awsv2"
)

const endpoint = "" // e.g. https://opensearch-domain.region.com or Amazon OpenSearch Serverless endpoint
Expand Down
4 changes: 2 additions & 2 deletions _samples/advanced_index_actions.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
4 changes: 2 additions & 2 deletions _samples/bulk.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
4 changes: 2 additions & 2 deletions _samples/data_stream.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
4 changes: 2 additions & 2 deletions _samples/document_lifecycle.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
4 changes: 2 additions & 2 deletions _samples/index_lifecycle.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
4 changes: 2 additions & 2 deletions _samples/json.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

const IndexName = "go-test-index1"
Expand Down
4 changes: 2 additions & 2 deletions _samples/search.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ import (
"strings"
"time"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion error_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v4"
)

func TestError(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/opensearch-project/opensearch-go/v3
module github.com/opensearch-project/opensearch-go/v4

go 1.21

Expand Down
2 changes: 1 addition & 1 deletion guides/advanced_index_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion guides/bulk.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion guides/data_streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion guides/document_lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion guides/index_lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
4 changes: 2 additions & 2 deletions guides/index_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion guides/json.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import (
"os"
"strings"

"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion guides/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import (
"strconv"
"strings"

"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

func main() {
Expand Down
4 changes: 2 additions & 2 deletions internal/test/helper.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ import (
"github.com/stretchr/testify/require"
"github.com/wI2L/jsondiff"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

// NewClient returns an opensearchapi.Client that is adjusted for the wanted test case
Expand Down
2 changes: 1 addition & 1 deletion internal/version/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@
package version

// Client returns the client version as a string.
const Client = "3.1.1"
const Client = "4.0.0"
6 changes: 3 additions & 3 deletions opensearch.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ import (
"strings"
"time"

"github.com/opensearch-project/opensearch-go/v3/internal/version"
"github.com/opensearch-project/opensearch-go/v3/opensearchtransport"
"github.com/opensearch-project/opensearch-go/v3/signer"
"github.com/opensearch-project/opensearch-go/v4/internal/version"
"github.com/opensearch-project/opensearch-go/v4/opensearchtransport"
"github.com/opensearch-project/opensearch-go/v4/signer"
)

const (
Expand Down
4 changes: 2 additions & 2 deletions opensearch_benchmark_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ import (
"strings"
"testing"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
)

type FakeTransport struct {
Expand Down
6 changes: 3 additions & 3 deletions opensearch_example_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ import (
"os"
"time"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v3/opensearchtransport"
"github.com/opensearch-project/opensearch-go/v4"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4/opensearchtransport"
)

func init() {
Expand Down
8 changes: 4 additions & 4 deletions opensearch_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ import (

"github.com/stretchr/testify/require"

"github.com/opensearch-project/opensearch-go/v3"
ostest "github.com/opensearch-project/opensearch-go/v3/internal/test"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
"github.com/opensearch-project/opensearch-go/v3/opensearchtransport"
"github.com/opensearch-project/opensearch-go/v4"
ostest "github.com/opensearch-project/opensearch-go/v4/internal/test"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
"github.com/opensearch-project/opensearch-go/v4/opensearchtransport"
)

func TestClientTransport(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion opensearch_internal_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/opensearch-project/opensearch-go/v3/opensearchtransport"
"github.com/opensearch-project/opensearch-go/v4/opensearchtransport"
)

var called int
Expand Down
2 changes: 1 addition & 1 deletion opensearchapi/api_aliases.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
"io"
"net/http"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v4"
)

// Aliases executes an /_aliases request with the required AliasesReq
Expand Down
6 changes: 3 additions & 3 deletions opensearchapi/api_aliases_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ import (

"github.com/stretchr/testify/require"

ostest "github.com/opensearch-project/opensearch-go/v3/internal/test"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
osapitest "github.com/opensearch-project/opensearch-go/v3/opensearchapi/internal/test"
ostest "github.com/opensearch-project/opensearch-go/v4/internal/test"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
osapitest "github.com/opensearch-project/opensearch-go/v4/opensearchapi/internal/test"
)

func TestAliases(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion opensearchapi/api_bulk.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (
"net/http"
"strings"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v4"
)

// Bulk executes a /_bulk request with the needed BulkReq
Expand Down
6 changes: 3 additions & 3 deletions opensearchapi/api_bulk_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

ostest "github.com/opensearch-project/opensearch-go/v3/internal/test"
"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
osapitest "github.com/opensearch-project/opensearch-go/v3/opensearchapi/internal/test"
ostest "github.com/opensearch-project/opensearch-go/v4/internal/test"
"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
osapitest "github.com/opensearch-project/opensearch-go/v4/opensearchapi/internal/test"
)

func TestBulkClient(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion opensearchapi/api_cat-aliases.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
"net/http"
"strings"

"github.com/opensearch-project/opensearch-go/v3"
"github.com/opensearch-project/opensearch-go/v4"
)

// CatAliasesReq represent possible options for the /_cat/aliases request
Expand Down
Loading
Loading