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 note for 2.5.0 #135

Merged
merged 11 commits into from
Jan 11, 2023
Merged

Add release note for 2.5.0 #135

merged 11 commits into from
Jan 11, 2023

Conversation

mingshl
Copy link
Collaborator

@mingshl mingshl commented Jan 11, 2023

Description

Add release notes for 2.5.0

@mingshl mingshl added 2.x 2.x branch backport 2.x v2.5.0 maintenance A change to add support for new versions of OpenSearch or OpenSearch Dashboards from upstream. backport 2.5 labels Jan 11, 2023
@mingshl mingshl requested a review from a team January 11, 2023 00:40
@mingshl mingshl self-assigned this Jan 11, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jan 11, 2023

Codecov Report

Merging #135 (6778c48) into main (a866df1) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #135   +/-   ##
=======================================
  Coverage   81.42%   81.42%           
=======================================
  Files          13       13           
  Lines         140      140           
  Branches       27       27           
=======================================
  Hits          114      114           
  Misses         24       24           
  Partials        2        2           
Flag Coverage Δ
dashboards-search-relevance 81.42% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@mingshl mingshl changed the title Add release notes for 2.5.0 Add release note for 2.5.0 Jan 11, 2023
@@ -0,0 +1,13 @@
Compatible with OpenSearch and OpenSearch Dashboards Version 2.5.0
### 🛡 Security
* Update yarn.lock ([#107](https://github.com/opensearch-project/dashboards-search-relevance/pull/107))([#113](https://github.com/opensearch-project/dashboards-search-relevance/pull/113))
Copy link
Collaborator

Choose a reason for hiding this comment

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

also #107?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

107 and 113 are for the 3 cve security fix.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we not combine them?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

notified in other repo, if multiple PR for the same issues, they are likely notified in the same bullet point, sample here

Copy link
Collaborator

Choose a reason for hiding this comment

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

If you really want to do that, then please also refine the content to be more meaningful

Copy link
Collaborator

Choose a reason for hiding this comment

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

I like keeping them on the same line. I also agree with making the descriptions more meaningful by saying why the pull request exists in the title. Moving forward, let's make PR titles part of the review process so this doesn't HAVE to be handled in the release notes.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@noCharger @macohen rename the pr title #113 with Bump version for ansi-regex, gs, glob-parent and update yarn.lock. I hope this title make more sense for the 3 packages version update and yarn lock update all together.

Copy link
Collaborator

@msfroh msfroh Jan 11, 2023

Choose a reason for hiding this comment

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

We don't need commit subject lines to explain why a commit is made. See https://cbea.ms/git-commit/ for guidance.

However, we do need the release notes to summarize things in a way that's relevant to readers.

Edit: If we're talking about PR subject lines, I guess that's fine. By default, that's the commit subject, but yeah, we can always fix them up at PR time.

Signed-off-by: Mingshi Liu <mingshl@amazon.com>
Signed-off-by: Mingshi Liu <mingshl@amazon.com>
Copy link
Collaborator

@noCharger noCharger left a comment

Choose a reason for hiding this comment

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

The new message is a good summary of both PRs. Approved

@mingshl mingshl merged commit c9ebb2e into opensearch-project:main Jan 11, 2023
github-actions bot added a commit that referenced this pull request Jan 11, 2023
* Add config rule in release note for security category

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* Add Release Notes for 2.4.1

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* 2.4 changing to 2.4.0

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* Add Release Notes for 2.5.0

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* Add related ticket 107

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* rename pr 113

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* remove extra space

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

Signed-off-by: Mingshi Liu <mingshl@amazon.com>
(cherry picked from commit c9ebb2e)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
github-actions bot added a commit that referenced this pull request Jan 11, 2023
* Add config rule in release note for security category

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* Add Release Notes for 2.4.1

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* 2.4 changing to 2.4.0

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* Add Release Notes for 2.5.0

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* Add related ticket 107

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* rename pr 113

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* remove extra space

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

Signed-off-by: Mingshi Liu <mingshl@amazon.com>
(cherry picked from commit c9ebb2e)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
mingshl pushed a commit that referenced this pull request Jan 11, 2023
* Add config rule in release note for security category

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* Add Release Notes for 2.4.1

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* 2.4 changing to 2.4.0

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* Add Release Notes for 2.5.0

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* Add related ticket 107

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* rename pr 113

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* remove extra space

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

Signed-off-by: Mingshi Liu <mingshl@amazon.com>
(cherry picked from commit c9ebb2e)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Signed-off-by: Mingshi Liu <mingshl@amazon.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
mingshl pushed a commit that referenced this pull request Jan 11, 2023
* Add config rule in release note for security category

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* Add Release Notes for 2.4.1

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* 2.4 changing to 2.4.0

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* Add Release Notes for 2.5.0

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* Add related ticket 107

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* rename pr 113

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

* remove extra space

Signed-off-by: Mingshi Liu <mingshl@amazon.com>

Signed-off-by: Mingshi Liu <mingshl@amazon.com>
(cherry picked from commit c9ebb2e)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Signed-off-by: Mingshi Liu <mingshl@amazon.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.x 2.x branch backport 2.x backport 2.5 maintenance A change to add support for new versions of OpenSearch or OpenSearch Dashboards from upstream. v2.5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants