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

Upgrade the plugin to support Opensearch 2.10.0 #226

Closed
wants to merge 2 commits into from

Conversation

vijay2308
Copy link

@vijay2308 vijay2308 commented Sep 26, 2023

Upgrade the plugin to support Opensearch 2.10.0
Updates the documentation for plugin version 2.10.0.0

Opensearch 2.10.0 Release Notes

Description

Upgrade the plugin to support Opensearch 2.10.0
Updates the documentation for plugin version 2.10.0.0

Describe your PR and add links to relevant issues.


  • All my commits include DCO.
    DCO stands for Developer Certificate of Origin and it is your declaration that your contribution is correctly attributed and licensed. Please read more about how to attach DCO to your commits here (spoiler alert: in most cases it is as simple as using -s option when doing git commit).
    Please be aware that commits without DCO will cause failure of PR CI workflow and can not be merged.

@vijay2308 vijay2308 changed the title Upgrade to Opensearch 2.10.0 Upgrade the plugin to support Opensearch 2.10.0 Sep 26, 2023
updates documentation
@vinylen
Copy link
Contributor

vinylen commented Sep 26, 2023

I think the commits lacks DCO so the PR CI workflow will fail. If so, read up on how to fix this here.

Also, we might want to squash the commits before merging into main?

@vinylen
Copy link
Contributor

vinylen commented Sep 27, 2023

Can we have some attention on this? :) @lukas-vlcek

@lukas-vlcek
Copy link
Collaborator

The issue was that OpenSearch 2.10.0 introduced some minor breaking changes (specifically, it moved some classes to different packages). See #230 for details.

@lukas-vlcek
Copy link
Collaborator

Hi @vijay2308

thanks for the PR!

When it comes to cutting a new release we have a document (RELEASE_PROCESS.md) to help navigate through the process. We try not to include commits for OpenSearch upgrade and for README.md file update in a single PR. It is safer to make sure we first merge commit with OpenSearch upgrade (making sure CI jobs pass, in this case some coding was needed, see #230) and then we merge the commit with README.md file update which then becomes the "release commit" (it gets the git tag and the repository should at this point in time include everything that is needed to replicate identical build that is found in the Release, see #232).

So, it is more practical to have two separate PRs.

As @vinylen pointed out we also require that all commits have their DCO. I know that for a simple update in markdown document this sounds like we are asking too much but it has its value. Imagine: what if in the future this plugin will get a chance to move under the same organization as OpenSearch itself or into its code base directly (for example when OpenSearch moves under independent foundation) then it will help if all commits are properly DCO signed.

Signing commits costs you nothing, just make sure you have the [user] section in .git/config file properly setup
and then use -s option when doing a commit: git commit -s ....

This is what I have in my file:

$ cat .git/config
...
[user]
	name = Lukáš Vlček
	email = lukas.vlcek@aiven.io
...

I am closing this PR for now, please keep your PRs coming 👍

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.

3 participants