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

Add release notes for version 2.1.0 #3773

Merged
merged 9 commits into from
Jul 7, 2022
Merged

Add release notes for version 2.1.0 #3773

merged 9 commits into from
Jul 7, 2022

Conversation

Rishikesh1159
Copy link
Member

@Rishikesh1159 Rishikesh1159 commented Jul 5, 2022

Description

This commit adds the release notes for the v2.1.0 Release starting from 2.x version bump to 2.1.

Issues Resolved

part of #3636

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff

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.

@Rishikesh1159 Rishikesh1159 requested review from a team and reta as code owners July 5, 2022 15:57
@github-actions
Copy link
Contributor

github-actions bot commented Jul 5, 2022

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

github-actions bot commented Jul 5, 2022

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

github-actions bot commented Jul 5, 2022

Gradle Check (Jenkins) Run Completed with:


#### Upgrades

* [Upgrade] Lucene-9.3.0-snapshot-b7231bb (#3537) ([#3555](https://github.com/opensearch-project/opensearch/pull/3555))
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 need to mention these incremental snapshot commits (that have since been changed) in release notes. Instead we can mention the upgrade to 9.2.0 with 157e693.

Copy link
Member Author

Choose a reason for hiding this comment

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

yes I think you are right, let me remove those other commits and just add upgrade to 9.2.0 with 157e693. Thanks @mch2

* Restore renaming method onMaster() and offMaster() in interface LocalNodeMasterListener ([#3687](https://github.com/opensearch-project/opensearch/pull/3687))
* Revert renaming masterOperation() to clusterManagerOperation() ([#3682](https://github.com/opensearch-project/opensearch/pull/3682))
* Restore AcknowledgedResponse and AcknowledgedRequest to package org.opensearch.action.support.master (#3669) ([#3670](https://github.com/opensearch-project/opensearch/pull/3670))
* Remove class org.opensearch.action.support.master.AcknowledgedResponse (#3662) ([#3668](https://github.com/opensearch-project/opensearch/pull/3668))
Copy link
Collaborator

@tlfeng tlfeng Jul 5, 2022

Choose a reason for hiding this comment

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

Could you remove the L30-33? (PR 3668 3670 3682 3687)
They are used for reverting a few wrong changes, and those changes have not been released yet. 😁

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure thanks @tlfeng , that makes sense to remove them as they are just revert of wrong changes

@github-actions
Copy link
Contributor

github-actions bot commented Jul 5, 2022

Gradle Check (Jenkins) Run Completed with:

@@ -0,0 +1,77 @@
## 2022-07-05 Version 2.1.0 Release Notes
Copy link
Member

Choose a reason for hiding this comment

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

Curious how this list is generated ?
Is it manual today?

Copy link
Member Author

Choose a reason for hiding this comment

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

I was following the steps mentioned by @peternied here to just generate the list of all commit. And yes we still have to manually go through each PR and filter out it into either of the sections (like Enhancements/bug fixes/Maintainance)

Copy link
Member

Choose a reason for hiding this comment

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

@Rishikesh1159 Glad to see this documentation was useful. What do you think about amending your commit message to include these steps as well, like from 2b92ca9?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah sure that's a good idea. Let me amend my commit

…rate release notes.

How to repeat:
* `git checkout origin/2.0`
* `git log --pretty=format:"* %s" --since=origin/2.0 > release-notes/opensearch-security.release-notes-2.0.0.0-rc1.md`
* Manually organize file sections
  * Add Date / Version section (copy + modify from previous release)
  * Enhancements/Bug fixes/Maintenance
* Replace pull request ids with full urls via regex
  * Find: `\(#(\d+)\)$`
  * Replace: `([#$1](https://github.com/opensearch-project/opensearch/pull/$1))`
* Commit with these steps / modified with additional details

Signed-off-by: Rishikesh1159 <[email protected]>
@github-actions
Copy link
Contributor

github-actions bot commented Jul 6, 2022

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

github-actions bot commented Jul 7, 2022

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

github-actions bot commented Jul 7, 2022

Gradle Check (Jenkins) Run Completed with:


#### Remove Mapping types

* [Type removal] Ignore _type field in bulk request ([#3505](https://github.com/opensearch-project/opensearch/pull/3505))
Copy link
Member

@dreamer-89 dreamer-89 Jul 7, 2022

Choose a reason for hiding this comment

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

This commit was reverted as part of #3560 (below). We can remove this commit along with 3560.

* Add flat_skew setting to node overload decider (#3563) ([#3582](https://github.com/opensearch-project/opensearch/pull/3582))
* Revert beat types changes 2x ([#3560](https://github.com/opensearch-project/opensearch/pull/3560))
* Revert "[Remove] MainResponse version override cluster setting (#3031) (#3032)" ([#3530](https://github.com/opensearch-project/opensearch/pull/3530))
* Revert removal of typed end-points for bulk, search, index APIs ([#3524](https://github.com/opensearch-project/opensearch/pull/3524))
Copy link
Member

@dreamer-89 dreamer-89 Jul 7, 2022

Choose a reason for hiding this comment

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

This was reverted as part of #3560. We can remove this commit along with 3560

Copy link
Member

@dreamer-89 dreamer-89 left a comment

Choose a reason for hiding this comment

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

We can remove few commits (and their reverts) as it will confuse the audience. We followed same for 2.0.1 release.

* Fix NPE when minBound/maxBound is not set before being called. (#3605) ([#3610](https://github.com/opensearch-project/opensearch/pull/3610))
* Fix for bug showing incorrect awareness attributes count in AwarenessAllocationDecider (#3428) ([#3580](https://github.com/opensearch-project/opensearch/pull/3580))
* Add flat_skew setting to node overload decider (#3563) ([#3582](https://github.com/opensearch-project/opensearch/pull/3582))
* Revert beat types changes 2x ([#3560](https://github.com/opensearch-project/opensearch/pull/3560))
Copy link
Member

Choose a reason for hiding this comment

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

This can be removed as it is revert commit.

* Fix for bug showing incorrect awareness attributes count in AwarenessAllocationDecider (#3428) ([#3580](https://github.com/opensearch-project/opensearch/pull/3580))
* Add flat_skew setting to node overload decider (#3563) ([#3582](https://github.com/opensearch-project/opensearch/pull/3582))
* Revert beat types changes 2x ([#3560](https://github.com/opensearch-project/opensearch/pull/3560))
* Revert "[Remove] MainResponse version override cluster setting (#3031) (#3032)" ([#3530](https://github.com/opensearch-project/opensearch/pull/3530))
Copy link
Member

@dreamer-89 dreamer-89 Jul 7, 2022

Choose a reason for hiding this comment

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

We should highlight this commit to signify that 2.1 supports version spoofing against 2.0.0 where it was removed. This temporary fix allows external clients such as beats (broken without this commit; more details in 3484) to work with OpenSearch engine.

I think out of existing sections, it belongs to feature/enhancement section though technically it is a workaround to work with external clients.

@viceice
Copy link

viceice commented Jul 7, 2022

pretty bad, the notes for v2.0.0 are also missing. 😕

the links from GitHub release are 404 because of this.

How to repeat:
* `git checkout origin/2.0`
* `git log --pretty=format:"* %s" --since=3-23-2022 > release-notes/opensearch.release-notes-2.1.0.md`
* Manually organize file sections
  * Add Date / Version section (copy + modify from previous release)
  * Enhancements/Bug fixes/Maintenance
* Replace pull request ids with full urls via regex
  * Find: `\(#(\d+)\)$`
  * Replace: `([#$1](https://github.com/opensearch-project/opensearch/pull/$1))`
* Commit with these steps / modified with additional details

Signed-off-by: Rishikesh1159 <[email protected]>
…9/OpenSearch into 2.1.0-release-notes.

How to repeat:
* `git checkout origin/2.1`
* `git log --pretty=format:"* %s" --since=3-23-2022 > release-notes/opensearch.release-notes-2.1.0.md`
* Manually organize file sections
  * Add Date / Version section (copy + modify from previous release)
  * Enhancements/Bug fixes/Maintenance
* Replace pull request ids with full urls via regex
  * Find: `\(#(\d+)\)$`
  * Replace: `([#$1](https://github.com/opensearch-project/opensearch/pull/$1))`
* Commit with these steps / modified with additional details

Signed-off-by: Rishikesh1159 <[email protected]>
How to repeat:
* `git checkout origin/2.1`
* `git log --pretty=format:"* %s" --since=3-23-2022 > release-notes/opensearch.release-notes-2.1.0.md`
* Manually organize file sections
  * Add Date / Version section (copy + modify from previous release)
  * Enhancements/Bug fixes/Maintenance
* Replace pull request ids with full urls via regex
  * Find: `\(#(\d+)\)$`
  * Replace: `([#$1](https://github.com/opensearch-project/opensearch/pull/$1))`
* Commit with these steps / modified with additional details

Signed-off-by: Rishikesh1159 <[email protected]>
@saratvemulapalli
Copy link
Member

pretty bad, the notes for v2.0.0 are also missing. 😕

the links from GitHub release are 404 because of this.

@viceice the release notes for 2.0 is working for me: https://github.com/opensearch-project/OpenSearch/blob/main/release-notes/opensearch.release-notes-2.0.0.md
Could you point to the link where you are seeing 404?

Copy link
Member

@saratvemulapalli saratvemulapalli left a comment

Choose a reason for hiding this comment

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

Thanks @Rishikesh1159 for taking care of this.

Could you list down the process you've taken to generate this list?
There are a couple of open issues which track this problem:
#1868
#789

Copy link
Member

@dreamer-89 dreamer-89 left a comment

Choose a reason for hiding this comment

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

LGTM!

@Rishikesh1159
Copy link
Member Author

Thanks @saratvemulapalli , @dreamer-89 for quick reviews. Sure Sarat I will list down the process to generate release notes in those issues.

@Rishikesh1159
Copy link
Member Author

Waiting for gradle check to pass before merging this PR

@github-actions
Copy link
Contributor

github-actions bot commented Jul 7, 2022

Gradle Check (Jenkins) Run Completed with:

@codecov-commenter
Copy link

Codecov Report

❗ No coverage uploaded for pull request base (main@289c2d3). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #3773   +/-   ##
=======================================
  Coverage        ?   70.46%           
  Complexity      ?    56615           
=======================================
  Files           ?     4557           
  Lines           ?   272681           
  Branches        ?    40038           
=======================================
  Hits            ?   192153           
  Misses          ?    64308           
  Partials        ?    16220           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 289c2d3...4fb42e0. Read the comment docs.

@Rishikesh1159 Rishikesh1159 merged commit c08e5ac into opensearch-project:main Jul 7, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jul 7, 2022

Gradle Check (Jenkins) Run Completed with:

* Removing unused method from TransportSearchAction (#3437) ([#3445](https://github.com/opensearch-project/opensearch/pull/3445))
* Fix Lucene-snapshots repo for jdk 17. (#3396) ([#3404](https://github.com/opensearch-project/opensearch/pull/3404))
* Temporary adding Apache Lucene repositories for snapshots (#3042) ([#3047](https://github.com/opensearch-project/opensearch/pull/3047))
* [Remove] MainResponse version override cluster setting (#3031) ([#3032](https://github.com/opensearch-project/opensearch/pull/3032))
Copy link
Member

Choose a reason for hiding this comment

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

This was removed & then reverted, It does not need to be in these notes.

Copy link
Member

@dreamer-89 dreamer-89 Jul 7, 2022

Choose a reason for hiding this comment

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

This was removed in 2.0.0, and recently reverted (added back) for 2.0.1. Shouldn't this commit be included as it was missing in 2.0.0 ?

## 2022-07-07 Version 2.1.0 Release Notes


### Breaking Changes in 2.1.0
Copy link
Member

Choose a reason for hiding this comment

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

None of these changes appear to be breaking to me, this looks like copy/paste error, we should update and remove this.

@Rishikesh1159
Copy link
Member Author

Sorry for incorrectly adding Breaking changes Heading in this PR. Breaking changes only happen in major versions. I put out a PR for fixing this #3817

@viceice
Copy link

viceice commented Jul 8, 2022

pretty bad, the notes for v2.0.0 are also missing. 😕
the links from GitHub release are 404 because of this.

@viceice the release notes for 2.0 is working for me: https://github.com/opensearch-project/OpenSearch/blob/main/release-notes/opensearch.release-notes-2.0.0.md Could you point to the link where you are seeing 404?

🤔 Can't find it anymore. maybe i made a mistake. Thanks for new releasenotes for v2.1. Maybe those should be created automatically on release, so we don't get those 404 when checking for new releases until the notes file is pushed.

opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 8, 2022
* Adding release notes for opensearch 2.1.0

How to repeat:
* `git checkout origin/2.1`
* `git log --pretty=format:"* %s" --since=3-23-2022 > release-notes/opensearch.release-notes-2.1.0.md`
* Manually organize file sections
  * Add Date / Version section (copy + modify from previous release)
  * Enhancements/Bug fixes/Maintenance
* Replace pull request ids with full urls via regex
  * Find: `\(#(\d+)\)$`
  * Replace: `([#$1](https://github.com/opensearch-project/opensearch/pull/$1))`
* Commit with these steps / modified with additional details

Signed-off-by: Rishikesh1159 <[email protected]>
(cherry picked from commit c08e5ac)
Rishikesh1159 added a commit that referenced this pull request Jul 8, 2022
* Adding release notes for opensearch 2.1.0

How to repeat:
* `git checkout origin/2.1`
* `git log --pretty=format:"* %s" --since=3-23-2022 > release-notes/opensearch.release-notes-2.1.0.md`
* Manually organize file sections
  * Add Date / Version section (copy + modify from previous release)
  * Enhancements/Bug fixes/Maintenance
* Replace pull request ids with full urls via regex
  * Find: `\(#(\d+)\)$`
  * Replace: `([#$1](https://github.com/opensearch-project/opensearch/pull/$1))`
* Commit with these steps / modified with additional details

Signed-off-by: Rishikesh1159 <[email protected]>
(cherry picked from commit c08e5ac)

Co-authored-by: Rishikesh Pasham <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants