Clarified branching and versioning for plugins. #33
Conversation
Signed-off-by: dblock <[email protected]>
|
@saratvemulapalli care to take a look please? |
RELEASING.md
Outdated
|
|
||
| Label PRs with the next major version label (e.g. `2.0.0`) and merge changes into `main`. Label PRs that you believe need to be backported as `1.x` and `1.0`. Backport PRs by checking out the versioned branch, cherry-pick changes and open a PR against each target backport branch. | ||
|
|
||
| ### Plugin Branching | ||
|
|
||
| Plugins, such as [job-scheduler](https://github.com/opensearch-project/job-scheduler) aren't as active as OpenSearch, and typically track 2 releases in parallel instead of 3. For example, given the last major release of 1.0, job-scheduler maintains the following active branches. |
There was a problem hiding this comment.
I understand why we'd like to reduce it to 2 branches.
We should communicate to plugins and remove 1.x branches if they've already created.
There was a problem hiding this comment.
I actually don't think a 1.x branch is a bad idea. It will make things easier to merge. Text below talks about that.
There was a problem hiding this comment.
Can we explicitly add that 1,x is optional for plugins?
There was a problem hiding this comment.
But it's not. What's optional is that you work on the 1.x branch to do active development. Which is explained in the example right below this paragraph.
There was a problem hiding this comment.
It seems to have confused two different readers, so perhaps things are not clear?
There was a problem hiding this comment.
You're right. See my update in eb83b9d
RELEASING.md
Outdated
|
|
||
| Label PRs with the next major version label (e.g. `2.0.0`) and merge changes into `main`. Label PRs that you believe need to be backported as `1.x` and `1.0`. Backport PRs by checking out the versioned branch, cherry-pick changes and open a PR against each target backport branch. | ||
|
|
||
| ### Plugin Branching | ||
|
|
||
| Plugins, such as [job-scheduler](https://github.com/opensearch-project/job-scheduler) aren't as active as OpenSearch, and typically track 2 releases in parallel instead of 3. For example, given the last major release of 1.0, job-scheduler maintains the following active branches. |
There was a problem hiding this comment.
Can we explicitly add that 1,x is optional for plugins?
Signed-off-by: dblock <[email protected]>
Signed-off-by: dblock [email protected]
Description
I attempted to clarify what we're doing right now for 1.1.
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.