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

[BUG] Names don't adhere to plugin naming convention #174

Open
3 of 10 tasks
dblock opened this issue Oct 18, 2022 · 13 comments
Open
3 of 10 tasks

[BUG] Names don't adhere to plugin naming convention #174

dblock opened this issue Oct 18, 2022 · 13 comments
Assignees
Labels
bug Something isn't working campaign Parent issues of OpenSearch release campaigns.

Comments

@dblock
Copy link
Member

dblock commented Oct 18, 2022

What is the bug?

We have published a plugins naming convention to https://github.com/opensearch-project/opensearch-plugins/blob/main/CONVENTIONS.md#plugin-naming-conventions in #56, but are failing to adhere to these consistently

What is the expected behavior?

Plugins follow the convention.

  1. Evaluate and publish the delta.
  2. Update contentions if needed.
  3. Align all names to the convention.
@dblock dblock added bug Something isn't working untriaged campaign Parent issues of OpenSearch release campaigns. labels Oct 18, 2022
@elfisher
Copy link

@mnkugler could you help pick this one up?

@mnkugler
Copy link
Contributor

@elfisher sure!

@elfisher
Copy link

@elfisher sure!

Thanks!

@mnkugler
Copy link
Contributor

Can anyone comment on the implications of renaming a plugin? For example, how do we handle existing dependencies? With an alias?

@davidlago
Copy link

May the first brave team renaming their plugin serve as a tracer bullet for this 🎖️

If this ends up being bigger than a breadbox, we should have the discussion around whether the juice is worth the squeeze especially for plugin repos given that we are thinking of what the next iteration of plugins would be and they might be on a (albeit long) deprecation path. 🤔

@macohen
Copy link
Contributor

macohen commented Oct 25, 2022

Oh man. Renaming plugins sounds like a painful process. But, can we ensure that naming is consistent moving forward? In what cases from the CONVENTIONS.md doc does "These are recommended plugin naming conventions. YMMV." really apply if we do want consistency?

@dblock
Copy link
Member Author

dblock commented Oct 25, 2022

+1 on getting rid of YMMV

@amitgalitz
Copy link
Member

For current plugins that have already been published to maven without following the convention, will we create a new plugin name and release under a new name?

@dblock
Copy link
Member Author

dblock commented Dec 6, 2022

@amitgalitz Do you have a strong preference one way or another? Feels like 3.0 may be a good time to do this.

@amitgalitz
Copy link
Member

@amitgalitz Do you have a strong preference one way or another? Feels like 3.0 may be a good time to do this.

If we are thinking long term, I think 3.0 is a good time to do this as well. Developers should be expecting breaking changes, having to potentially change API, or gradle dependencies during 3.0 bump could make sense.

There are 2 things I can think of at least that we should consider before though.

  1. We should find the correct way to let users know of the change to a new release on maven since I don't know of an easy way to link one maven software to a separate maven software and label that as a continuation.

  2. We should only actually change plugin names for convention case if we figure out a way to really enforce these naming conventions. Even as recent as 2.4.0 we have new plugins that used the new onboarding issue creation process that still have incorrect plugin names.

@dblock dblock removed the untriaged label Jan 12, 2023
ananzh added a commit to ananzh/i18n-plugin-1 that referenced this issue Apr 7, 2023
* Rename due to plugin naming convention
* I18n is a self maintained repo and won't have a lot of updates
except translation files. Currently, OpenSearch Dashboards requests
all plugins to match its version. Therefore, we add a script to
update version in opensearch_dashboards.json automatically.

Issue Resolve
opensearch-project/opensearch-plugins#174

Signed-off-by: Anan Zhuang <[email protected]>
@mnkugler
Copy link
Contributor

mnkugler commented Apr 11, 2023

Dashboard Maps, SQL, Common Util, & Performance Analyzer RCA have all resolved their issues. The following table illustrates the 10 Repos left and their status:

Repo Issue Owner Status GH Issue
Index Management Dashboard Remove plugin from the repo name getsaurabh02 Fix after 2.11 release issue
Alerting Dashboard Remove plugin from the repo name getsaurabh02 Fix after 2.11 release issue
Security Analytics Dashboard Plugins Remove plugin from the repo name praveensameneni Fix after 2.11 release issue
Security Dashboard Plugin Remove plugin from the repo name davidlago Fix by 3.0 issue
Dashboard Visualization Folder needs to be fixed anirudha On hold and Ani will come up with a solution issue
Alerting Folder needs to be fixed getsaurabh02 Fix after 2.11 release issue
ML Commons opensearchplugin metadata is missing from build.gradle sean-zheng-amazon complete issue
Geospatial opensearchplugin metadata is missing from build.gradle vamshin complete issue
i18n Remove plugin from the repo name & Plugin ID needs to align with convention with camel case seanneumann Complete issue
Asynchronous Search Folder needs to be fixed dhruvdas complete issue

ananzh added a commit to opensearch-project/dashboards-i18n that referenced this issue May 11, 2023
* Rename due to plugin naming convention
* I18n is a self maintained repo and won't have a lot of updates
except translation files. Currently, OpenSearch Dashboards requests
all plugins to match its version. Therefore, we add a script to
update version in opensearch_dashboards.json automatically.

Issue Resolve
opensearch-project/opensearch-plugins#174

Signed-off-by: Anan Zhuang <[email protected]>
@mnkugler
Copy link
Contributor

mnkugler commented Sep 7, 2023

Updated chart: Alerting, Index Management, and Security Analytics is planning to work on removing the word “plugin” from the repo name after 2.11 to ensure the best timing for no breaking changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working campaign Parent issues of OpenSearch release campaigns.
Projects
None yet
Development

No branches or pull requests

6 participants