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

[FEATURE] document recommendation for java package & maven group name #98

Open
rursprung opened this issue Sep 5, 2024 · 2 comments
Open
Assignees
Labels
enhancement New feature or request

Comments

@rursprung
Copy link
Contributor

rursprung commented Sep 5, 2024

Is your feature request related to a problem?

the current template uses org.opensearch for the java package and maven artefacts. some (most? all?) third parties (examples: 1, 2) now release plugins also with these coordinates, making it unclear which of these are "official" plugins and which are not.

What solution would you like?

usually artefacts are published under the identifier of the actual publisher (e.g. "Example Inc." might publish as org.example instead of org.opensearch).
the outcome of this issue should be two things:

  • decision whether 3rd parties should/can publish plugins also as org.opensearch
  • documentation of this (either with a clear recommendation or clear discouragement) for new plugins as well as for existing plugins (most likely for these the statement is to not change anything or only change something when going to OpenSearch 3.0)

What alternatives have you considered?

in the current state where it's not documented and the template is using org.opensearch most will just use that and not think too much about it. thus it's a de-facto standard but not a de-jure standard.

Do you have any additional context?

opensearch-project/.github#209 discusses the process to move repos to the opensearch org. if plugins start out in another organisation (or user account) and use another java package & maven group name they might have to be renamed, leading to a breaking change for their users (though again, this could be put off until the next major release, and when the plugin release is decoupled from the OpenSearch release this should become easier; see also #8 (comment)).

@rursprung rursprung added enhancement New feature or request untriaged labels Sep 5, 2024
@andrross
Copy link
Member

[Catch All Triage - 1, 2, 3]

Thanks @rursprung. @AmiStrn can you follow up here?

@AmiStrn AmiStrn removed the untriaged label Sep 23, 2024
@AmiStrn AmiStrn self-assigned this Sep 23, 2024
@AmiStrn
Copy link
Collaborator

AmiStrn commented Sep 23, 2024

Thanks @rursprung this is a valid point!
I will amend the documentation and make sure the path is defined correctly.

AmiStrn added a commit to AmiStrn/opensearch-plugin-template-java that referenced this issue Oct 15, 2024
We should be encouraging users to create plugins outside the opensearch-project. We still need a formal process to include plugins into the project, but it is a good idea to avoid contradicting documentation. this commit resolves some of this ambiguity.

Signed-off-by: AmiStrn <123amitai@gmail.com>
dblock pushed a commit that referenced this issue Oct 17, 2024
We should be encouraging users to create plugins outside the opensearch-project. We still need a formal process to include plugins into the project, but it is a good idea to avoid contradicting documentation. this commit resolves some of this ambiguity.

Signed-off-by: AmiStrn <123amitai@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants