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

Announce upcoming breaking changes in packaging #4051

Merged

Conversation

smortex
Copy link
Contributor

@smortex smortex commented Sep 20, 2023

In #4043, we will introduce changes that might impact users. Add a note at installation time to warn them about this future change and how to proceed to not have trouble if they will be affected by the change.

In opensearch-project#4043, we will introduce changes that might impact users.  Add a note
at installation time to warn them about this future change and how to
proceed to not have trouble if they will be affected by the change.

Signed-off-by: Romain Tartière <[email protected]>
@codecov
Copy link

codecov bot commented Sep 20, 2023

Codecov Report

Merging #4051 (8b24e72) into main (4d53d69) will not change coverage.
Report is 3 commits behind head on main.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #4051   +/-   ##
=======================================
  Coverage   92.10%   92.10%           
=======================================
  Files         187      187           
  Lines        5677     5677           
=======================================
  Hits         5229     5229           
  Misses        448      448           

@peterzhuamazon
Copy link
Member

Hi @smortex,

Thanks for PR.

We need to think about how to only display this msg in 2.x+, not 1.x.
Or have a generic msg that suit for all versions.

cc: @bbarani @gaiksaya .

Thanks.

This will not be backported to 1.x packages, but since 1.x and 2.x
currently share the tooling, add information so that users are not
confused.

As users of 1.x are expected to switch to a newer version at some point,
include the informational message for them to prepare the sooner.

Signed-off-by: Romain Tartière <[email protected]>
@smortex
Copy link
Contributor Author

smortex commented Sep 20, 2023

I added a commit that try to make this more clear as you suggested in slack. Maybe native English speaker will be able to help us to make this more straightforward? The commit message has more details, but I think we deserve something concise as a post-installation message.

Signed-off-by: Peter Zhu <[email protected]>
@peterzhuamazon
Copy link
Member

peterzhuamazon commented Sep 20, 2023

Hi @smortex

Updated PR with some wording improvements.
Please take one more look before approving. Thanks.

@smortex
Copy link
Contributor Author

smortex commented Sep 20, 2023

👍 Excellent! LGTM!

Copy link
Member

@zelinh zelinh left a comment

Choose a reason for hiding this comment

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

LGTM.

@peterzhuamazon peterzhuamazon merged commit 0efc775 into opensearch-project:main Sep 20, 2023
12 checks passed
@smortex smortex deleted the announce-future-breaking-change branch September 20, 2023 23:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

4 participants