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

[DOC] Document support for semver range specification for plugin compatibility for 2.13.0 #6433

Closed
1 of 4 tasks
abseth-amzn opened this issue Feb 18, 2024 · 4 comments · Fixed by #6733
Closed
1 of 4 tasks
Assignees
Labels
3 - Done Issue is done/complete v2.13.0
Milestone

Comments

@abseth-amzn
Copy link
Contributor

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request.
We have added support for specifying 'dependencies' for a plugin in its plugin-descriptor.properties file. This will enable plugin developers to specify range of Opensearch versions that the plugin is compatible with using semver range notations. Following notations are currently supported:

  • dependencies={ opensearch: x.y.z }
  • dependencies={ opensearch: =x.y.z }
  • dependencies={ opensearch: ~x.y.z }
  • dependencies={ opensearch: ^x.y.z }

This support is available for version 2.13.0 and 3.x. Need to update documentation so we can share this new feature with plugin developers.

What other resources are available?
Related issue - opensearch-project/OpenSearch#1707
Related PR - opensearch-project/OpenSearch#11441
Backport PR to 2.x - opensearch-project/OpenSearch#12271

@hdhalter
Copy link
Contributor

Hi @abseth-amzn - do you think this change requires updates to the end user documentation (https://opensearch.org/docs/latest) or is it plugin developer documentation that belongs in the plugin repo? Thanks!

@abseth-amzn
Copy link
Contributor Author

Hello,
This change requires updates to both opensearch-plugins repo and public docs because it impacts both developers and end customers consuming plugins.

@hdhalter
Copy link
Contributor

Hello, This change requires updates to both opensearch-plugins repo and public docs because it impacts both developers and end customers consuming plugins.

OK, thanks! Do you want to put up the doc PR for this update?

@hdhalter
Copy link
Contributor

Hi @abseth-amzn - In order for this to be included in the release, we need a doc PR opened today for this change. Can you please create one? Thanks!

@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. labels Mar 20, 2024
@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete v2.13.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants