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

Add UPGRADING.md to document breaking changes #618

Merged
merged 2 commits into from
Apr 24, 2024

Conversation

Xtansia
Copy link
Collaborator

@Xtansia Xtansia commented Apr 23, 2024

Description

Add UPGRADING.md to document breaking changes

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.

Signed-off-by: Thomas Farr <tsfarr@amazon.com>
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

Add a link to UPGRADING in README.md. In other projects I've seen things like "You are reading the documentation for the next release of X. See UPGRADING for upgrading from a previous version.", but an entry in the list of the links would suffice too.

UPGRADING.md Show resolved Hide resolved
UPGRADING.md Outdated Show resolved Hide resolved
@Xtansia Xtansia requested a review from dblock April 23, 2024 23:44
Signed-off-by: Thomas Farr <tsfarr@amazon.com>
@dblock
Copy link
Member

dblock commented Apr 24, 2024

tests are failing ...

@Xtansia
Copy link
Collaborator Author

Xtansia commented Apr 24, 2024

tests are failing ...

@dblock Failing tests are unrelated one is a known flaky test (#443) others are breakages from building the unreleased k-nn plugin. Will investigate the build failures if it's something to fix on our end or not

@Xtansia Xtansia merged commit 896fa4d into opensearch-project:main Apr 24, 2024
34 of 36 checks passed
@Xtansia Xtansia deleted the docs/upgrading-md branch April 24, 2024 00:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants