opensearch-project / opensearch-go

Go Client for OpenSearch
https://opensearch.org/docs/latest/clients/go/
Apache License 2.0
197 stars 102 forks source link

Move error structs from opensearchapi to opensearch to be reused by plugins #512

Closed Jakob3xD closed 5 months ago

Jakob3xD commented 6 months ago

Description

This is a braking change as the error types are moved to another project and also get renamed. Needed as preparation for plugin integrations.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

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.

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 77.70%. Comparing base (06a6dc8) to head (c619002).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #512 +/- ## =========================================== + Coverage 57.29% 77.70% +20.41% =========================================== Files 315 13 -302 Lines 9823 1673 -8150 =========================================== - Hits 5628 1300 -4328 + Misses 2902 296 -2606 + Partials 1293 77 -1216 ``` | [Flag](https://app.codecov.io/gh/opensearch-project/opensearch-go/pull/512/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project) | Coverage Δ | | |---|---|---| | [integration](https://app.codecov.io/gh/opensearch-project/opensearch-go/pull/512/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project) | `?` | | | [unit](https://app.codecov.io/gh/opensearch-project/opensearch-go/pull/512/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project) | `77.70% <100.00%> (+64.85%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/opensearch-project/opensearch-go/pull/512?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project) | Coverage Δ | | |---|---|---| | [error.go](https://app.codecov.io/gh/opensearch-project/opensearch-go/pull/512?src=pr&el=tree&filepath=error.go&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project#diff-ZXJyb3IuZ28=) | `100.00% <100.00%> (ø)` | | ... and [304 files with indirect coverage changes](https://app.codecov.io/gh/opensearch-project/opensearch-go/pull/512/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project)
Jakob3xD commented 5 months ago

Looks like a publicly-facing backwards-incompatible breaking change? Unless you want to inherit these error types in old names and mark those deprecated, let's bump the version to 4 as part of it?

I adjusted the upgrading.md to version 4.0.0. Do you want the release done in this PR or after all my other PRs are merged? I'd prefer after all the others are merged.

dblock commented 5 months ago

Looks like a publicly-facing backwards-incompatible breaking change? Unless you want to inherit these error types in old names and mark those deprecated, let's bump the version to 4 as part of it?

I adjusted the upgrading.md to version 4.0.0. Do you want the release done in this PR or after all my other PRs are merged? I'd prefer after all the others are merged.

After. Usually the version number should be set on working code as early as possible so that nobody confuses it with released code of the previous version.