Update RELEASING.md #184
Update RELEASING.md #184
Conversation
Proposed an update to create a process for moving the release date. Signed-off-by: Mehul A. Shah <mashah@gmail.com>
mashah
requested review from
CEHENKLE,
dblock,
mch2,
peternied and
saratvemulapalli
as code owners
| @@ -110,6 +110,16 @@ OpenSearch only does major releases when there are significant breaking changes | |||
|
|
|||
| For the actual steps to build a release, please see [Releasing OpenSearch](https://github.com/opensearch-project/opensearch-build/blob/main/README.md#releasing-opensearch). | |||
|
|
|||
| ### Release Process for Changing Release Date | |||
There was a problem hiding this comment.
Add to TOC please.
How about we make a section called "Release Process" and sub-topics "Major Releases" and "Changing Release Dates"?
| @@ -110,6 +110,16 @@ OpenSearch only does major releases when there are significant breaking changes | |||
|
|
|||
| For the actual steps to build a release, please see [Releasing OpenSearch](https://github.com/opensearch-project/opensearch-build/blob/main/README.md#releasing-opensearch). | |||
|
|
|||
| ### Release Process for Changing Release Date | |||
|
|
|||
| In the OpenSearch project, we strive for consistent and predictable release schedule as multiple organizations and users depend on the software for their own projects and businesses. | |||
There was a problem hiding this comment.
I think we need to link to the place that says how (often) OpenSearch releases.
There was a problem hiding this comment.
I think we should update https://opensearch.org/releases.html#release-schedule with these details as well.
| * There is a publicly documented justification for moving the release date. | ||
| * The justification is circulated 2 weeks or more prior to the original release date. | ||
| * The organization coordinating the release is in favor of moving the release date. | ||
| * A majority of the leadership committee agree by vote to move the release date. |
There was a problem hiding this comment.
Do we have a link that talks about what the leadership committee is anywhere on .github? We should add it if we don't.
This might read clearer: "The leadership committee has voted to move the release date with a simple majority."
There was a problem hiding this comment.
Agreed @dblock . We should document the roles and responsibilities of leadership committee to avoid ambiguity.
| However, sometimes a release date needs to move to accommodate engineering delays in critical components that affect the key properties of the software such as | ||
| performance, reliability, availability, or security. In order to move a release date, we will ensure: | ||
|
|
||
| * There is a publicly documented justification for moving the release date. |
There was a problem hiding this comment.
I would say where we document it, aka the release ticket.
There was a problem hiding this comment.
Example of a release ticket: opensearch-project/opensearch-build#4115. Should the release ticket itself should go into the public roadmap: https://github.com/orgs/opensearch-project/projects/1?
There was a problem hiding this comment.
Again this should also go in to https://opensearch.org/releases.html
| performance, reliability, availability, or security. In order to move a release date, we will ensure: | ||
|
|
||
| * There is a publicly documented justification for moving the release date. | ||
| * The justification is circulated 2 weeks or more prior to the original release date. |
There was a problem hiding this comment.
is posted no later than 2 weeks ...
There was a problem hiding this comment.
Can we elaborate on documented justification? Is it GitHub issue in specific repo, Slack or something else..
|
Thanks for initiating this thread @mashah. Agree with LC review, however, primary drivers on date pushout will be a vote from maintainers and the infrastructure/release team that manages the release as they are aware of the technical challenges/last minute issues that might have led to a release delay. We need to still work through voting on github, but need to give enough time for stakeholders to review the proposed change |
|
|
||
| * There is a publicly documented justification for moving the release date. | ||
| * The justification is circulated 2 weeks or more prior to the original release date. | ||
| * The organization coordinating the release is in favor of moving the release date. |
There was a problem hiding this comment.
might be a nitpick: If the maintainers/release owners are in favor, is that enough? Something about the word "organization" here seems a little funny.
|
@mashah Thanks for opening this pull request, its been several weeks without activity, how can I help? |
Proposed an update to create a process with involvement from the leadership committee for moving the release date.
Description
See above.
Issues Resolved
See above.