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.

Sign up for GitHub

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

updating releases page to reflect release windows #1866

Merged
merged 9 commits into from
Aug 17, 2023
Merged

updating releases page to reflect release windows #1866

Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
dd6fa07
updated table to clarify release window, did an edit for clairity des…
CEHENKLE Aug 14, 2023
2f8bdea
updated date
CEHENKLE Aug 14, 2023
6ae0a72
added a release date column, caught another typo
CEHENKLE Aug 14, 2023
7ff19c4
clarified it's 1 week for 1.x
CEHENKLE Aug 14, 2023
689453f
updated changelog
CEHENKLE Aug 14, 2023
42a05c6
updated release history
CEHENKLE Aug 14, 2023
0950c51
updated dates for 2.11 and 2.12
CEHENKLE Aug 14, 2023
e0da9f0
clarified that it's 1 week for patch releases
CEHENKLE Aug 16, 2023
5012030
Update releases.md
krisfreedain Aug 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 12 additions & 20 deletions releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Release Schedule and Maintenance Policy
---


_Updated April 26, 2023_
_Updated August 14, 2023_

[Release Schedule](#release-schedule) · [Maintenance Policy](#maintenance-policy)

Expand All @@ -16,39 +16,30 @@ _Updated April 26, 2023_

For more information on the changes planned for each release, please see the [Project Roadmap](https://github.com/orgs/opensearch-project/projects/1)

### 2023 ###

Note: We have not added a major release to the 2023 schedule yet. If/when we add one, it will replace a minor release in the 2.x line. See below for criteria for a major releases.


<div class="table-styler"></div>

| Release Number| Code Freeze Date | Release Date |
|:--------------|:-----------------|:---------------|
| 2.5.0 | January 10th | January 24th |
| 1.3.8 | January 26th | February 2nd |
| 2.6.0 | February 21th | February 28th |
| 1.3.9 | March 9th | March 16th |
| 2.7.0 | April 17th | May 2nd |
| 1.3.10 | May 11th | May 18th |
| 2.8.0 | May 30th | June 6th |
| 1.3.11 | June 22nd | June 29th |
| 2.9.0 | July 11th | July 24th |
| 1.3.12 | August 3rd | August 10th |
| 2.10.0 | September 05th | TBD |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we want to delete this history as we move it to a 'Release History' section at the end of the year.

Copy link
Member Author

@CEHENKLE CEHENKLE Aug 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I reread your comment, and realized you were right. Sorry! Updated.

### 2023 ###
| Release Number| First RC Generated (release window opens) | Latest Possible Release Date (release window closes) | Release Date |
|:--------------|:-----------------|:---------------|:---------------|
| 2.10.0 | September 05th | September 19th |
| 1.3.13 | September 14th | September 21st |
| 2.11.0 | October 10th | TBD |
| 2.11.0 | October 10th | October 24th |
| 1.3.14 | November 9th | November 16th |
| 2.12.0 | November 30th | TBD |
| 2.12.0 | November 30th | December 14th |

OpenSearch [follows semver](https://opensearch.org/blog/technical-post/2021/08/what-is-semver/), which means we will only release breaking changes in major versions. All minor versions are compatible with every other minor version for that major. For example, 1.2.0 will work with 1.3.2, 1.4.1, etc, but may not work with 2.0.

For minor version releases, OpenSearch follows "release window" model as described in this [proposal](https://github.com/opensearch-project/.github/issues/150). We plan to release a new minor version approximately every six weeks which includes all the new features and fixes that are ready to go. The entry and exit criteria are defined for the artifacts to be released. Every day we generate a release candidate. When the exit criteria are met by a release candidate, we announce, update the release date (~2 days later) and publish release artifacts on that date.
For minor version releases, OpenSearch follows "release window" model as described in this [proposal](https://github.com/opensearch-project/.github/issues/150). The goal is to release a new minor version approximately every six weeks which includes all the new features and fixes that are ready to go. Once we enter a release window, every day we will generate a release candidate. When the exit criteria are met by a release candidate, we will make an announcement, update the release date column above and publish new artifacts on that date.

**Note:** If we cannot pass the exit criteria by 2 weeks after the start of the release cycle window, we will cancel the minor release and hold changes until the next release window.
**Note:** If we cannot pass the exit criteria by 2 weeks after the start of the release cycle window (1 week for 1.x releases), we will cancel the minor release and hold changes until the next release window.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We only do patch release in 1.x line. I assume the updated release process is only valid for minor and patch release will still follow release train model?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I updated it to being "1 week for 1.x patch releases", would that be more or less clear?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, Patch release still follows release train model so just want to make sure that no one gets confused with updated minor release process.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay, updated. Please review, LMK if there are any other changes. Thanks!


In contrast, OpenSearch releases new major versions only when there are a critical mass of breaking changes (e.g. changes that are incompatible with existing APIs). These tend to be tied to [Lucene](https://lucene.apache.org/) major version releases, and will be announced in the forums at least 4 weeks prior to the release date.

Please note: Both the roadmap and the release dates reflect intentions rather than firm commitments and may change as we learn more or encounters unexpected issues. If dates do need to change, we will be as transparent as possible, and log all changes in the changelog at the bottom of this page.
Both the roadmap and the release dates reflect intentions rather than firm commitments and may change as we learn more or encounters unexpected issues. If dates do need to change, we will be as transparent as possible, and log all changes in the changelog at the bottom of this page.


## Maintenance Policy ##
Expand Down Expand Up @@ -104,6 +95,7 @@ The software maintainers will not back-port fixes or features to versions outsid
| April 26, 2023 | Update to 2.7.0 release date | Found CVE to resolve, fix issues found in regression tests |
| July 17, 2023 | Update to 2.9.0 release date | No-Go on the release meeting call - build issues |
| July 20, 2023 | Update to 2.9.0 release date | No-Go on the release meeting call - build issues |
| August 14, 2023 | Updated release table to reflect release windows | per adoption of https://github.com/opensearch-project/project-website/pull/1866 |

<br>