opensearch-project / opensearch-project/opensearch-plugin-template-java

[FEATURE] How does one release a generic plugin?

Open
#36 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
33
Forks
32
Avg merge
2h 19m
Merged PRs (30d)
3

Description

Is your feature request related to a problem?

Other plugins, such as https://github.com/querqy/querqy-opensearch, want to be released independently of OpenSearch, following the release cadence that OpenSearch has, but not releasing as part of the default distribution.

What solution would you like?
  • Some guidelines such as "follow branching of OpenSearch core" and "make CI/CD build against OpenSearch core main, x.y and x.y.z".
  • An easy copy-pastable set of GHA workflows for a 1-click automated release.
  • a RELEASING.md that explains how to use the above workflow.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the opensearch-plugin-template-java repository and the linked querqy-opensearch plugin to understand the independent release context. Done means providing OpenSearch version and branching guidance, copy-pastable GitHub Actions workflows for automated releases, and a RELEASING.md explaining their use.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, java
Domain
ci-cd, documentation, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.