Added an automated api update bot for opensearch-py #664

saimedhi · 2024-01-31T08:26:09Z

Description

Added an automated api update bot for opensearch-py

Issues Resolved

Closes #619

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.

Signed-off-by: saimedhi saimedhi@amazon.com

codecov · 2024-01-31T08:27:38Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d905bef) 72.14% compared to head (53637ef) 72.14%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #664   +/-   ##
=======================================
  Coverage   72.14%   72.14%           
=======================================
  Files          89       89           
  Lines        7945     7945           
=======================================
  Hits         5732     5732           
  Misses       2213     2213

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

saimedhi · 2024-01-31T08:30:05Z

To install the opensearchpy-api-update-bot, the administrator must grant approval for the request.

Failing tests are related to issue #653

@VachaShah please take a look.

Signed-off-by: saimedhi <saimedhi@amazon.com>

saimedhi · 2024-01-31T22:56:49Z

@VachaShah, shall we merge it? Is there any other way to test?

.github/workflows/update_api.yml

VachaShah · 2024-02-01T00:46:35Z

@VachaShah, shall we merge it? Is there any other way to test?

You can test it on your fork (remove the github app token step since that is related to the org). It should work without it on your fork and you can post here the PR that is created from this workflow.

saimedhi · 2024-02-01T00:58:56Z

@VachaShah, I followed workflow given in the issue #619

Workflow: https://github.com/slack-ruby/slack-ruby-client/blob/master/.github/workflows/update_api.yml

Example outcome PR: saimedhi#24 produced with this workflow.

.github/workflows/update_api.yml

VachaShah · 2024-02-01T18:35:04Z

CHANGELOG.md

@@ -21,6 +22,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Fixed
 - Fix KeyError when scroll return no hits ([#616](https://github.com/opensearch-project/opensearch-py/pull/616))
 - Fix reuse of `OpenSearch` using `Urllib3HttpConnection` and `AsyncOpenSearch` after calling `close` ([#639](https://github.com/opensearch-project/opensearch-py/pull/639))
+### Automated API Update
+- Your contribution here.


Is this line Your contribution here needed?

Is this line Your contribution here needed?

Yes, to update changelog, find and replace is used. We can change the text if required.

You could reuse the title line, then you don't need the misleading "Your contribution here.", "### Automated API Update". Maybe call it "Updated APIs" to match the other sections language?

Trying to find a way to update only in ## [Unreleased] section.

If "### Updated APIs" is used for finding, it will be present in changelog at several places in future after next release.

Action jacobtomlinson/gha-find-replace@v3 will not help if ### Updated APIs is present in several places.

- name: Update CHANGELOG uses: jacobtomlinson/gha-find-replace@v3 with: find: "### Updated APIs" replace: "### Updated APIs\n- Updated opensearch-py to reflect the latest OpenSearch API spec." include: "**CHANGELOG.md"

Makes sense. I think that action could use a "replace first occurrence" feature, I took a look at the project and started with adding some unit tests - jacobtomlinson/gha-find-replace#61. Will follow up with that feature if it gets merged.

.github/workflows/update_api.yml

saimedhi · 2024-02-01T21:02:27Z

@VachaShah, please take a look. This workflow is working in my main branch but opensearch-py tests are not running on the created PR. PR created: saimedhi#29

Signed-off-by: saimedhi <saimedhi@amazon.com>

saimedhi · 2024-02-02T00:07:52Z

@VachaShah, please take a look. This workflow is working in my main branch but opensearch-py tests are not running on the created PR. PR created: saimedhi#29

On my fork all the tests are passing. (screenshots from workflows)
Failing tests are related to #652

VachaShah · 2024-02-02T00:26:13Z

@VachaShah, please take a look. This workflow is working in my main branch but opensearch-py tests are not running on the created PR. PR created: saimedhi#29

On my fork all the tests are passing. (screenshots from workflows) Failing tests are related to #652

@saimedhi I think these tests are not appearing on your PR because the checks are running on the first commit but not on the second commit. Lets try one thing here: we can move the update changelog commit step to before creating the PR? So the PR would be created with both the commits.

Signed-off-by: saimedhi <saimedhi@amazon.com>

saimedhi · 2024-02-02T03:03:53Z

@VachaShah, please take a look. This workflow is working in my main branch but opensearch-py tests are not running on the created PR. PR created: saimedhi#29

On my fork all the tests are passing. (screenshots from workflows) Failing tests are related to #652

@saimedhi I think these tests are not appearing on your PR because the checks are running on the first commit but not on the second commit. Lets try one thing here: we can move the update changelog commit step to before creating the PR? So the PR would be created with both the commits.

Made the changes as suggested.
PR created: saimedhi#33

dblock · 2024-02-02T15:42:33Z

.github/workflows/update_api.yml

+        if: ${{ steps.cpr.outputs.pull-request-number != '' }}
+        with:
+          find: "- Your contribution here."
+          replace: "- Updated opensearch-py to reflect the latest OpenSearch API spec.\n- Your contribution here."


Let's change these messages to be something more specific? e.g. the commit of opensearch-api-specification that was used? This way we don't have a thousand PRs/commit messages that have the same title?

dblock · 2024-02-05T17:21:14Z

@VachaShah you good with this?

…ct#664) * Added an automated api update bot for opensearch-py Signed-off-by: saimedhi <saimedhi@amazon.com> * Added an automated api update bot for opensearch-py Signed-off-by: saimedhi <saimedhi@amazon.com> * Added an automated api update bot for opensearch-py Signed-off-by: saimedhi <saimedhi@amazon.com> --------- Signed-off-by: saimedhi <saimedhi@amazon.com> Signed-off-by: AbitraryYu <nikkoyhc@gmail.com>

…ct#664) * Added an automated api update bot for opensearch-py Signed-off-by: saimedhi <saimedhi@amazon.com> * Added an automated api update bot for opensearch-py Signed-off-by: saimedhi <saimedhi@amazon.com> * Added an automated api update bot for opensearch-py Signed-off-by: saimedhi <saimedhi@amazon.com> --------- Signed-off-by: saimedhi <saimedhi@amazon.com>

saimedhi requested review from VachaShah, dblock, harshavamsi, axeoman, Shephalimittal and florianvazelle as code owners January 31, 2024 08:26

Added an automated api update bot for opensearch-py

88a69c2

Signed-off-by: saimedhi <saimedhi@amazon.com>

saimedhi force-pushed the automated_api_update branch from 9bb19a2 to 88a69c2 Compare January 31, 2024 22:43

VachaShah reviewed Feb 1, 2024

View reviewed changes

.github/workflows/update_api.yml Show resolved Hide resolved

VachaShah reviewed Feb 1, 2024

View reviewed changes

.github/workflows/update_api.yml Outdated Show resolved Hide resolved

VachaShah reviewed Feb 1, 2024

View reviewed changes

.github/workflows/update_api.yml Outdated Show resolved Hide resolved

VachaShah reviewed Feb 1, 2024

View reviewed changes

Added an automated api update bot for opensearch-py

d494e75

Signed-off-by: saimedhi <saimedhi@amazon.com>

saimedhi force-pushed the automated_api_update branch from 0b65e61 to d494e75 Compare February 1, 2024 21:34

Added an automated api update bot for opensearch-py

53637ef

Signed-off-by: saimedhi <saimedhi@amazon.com>

dblock reviewed Feb 2, 2024

View reviewed changes

dblock approved these changes Feb 5, 2024

View reviewed changes

VachaShah approved these changes Feb 5, 2024

View reviewed changes

saimedhi merged commit 54e2fb6 into opensearch-project:main Feb 5, 2024
41 of 55 checks passed

saimedhi mentioned this pull request Feb 5, 2024

Fixed automated api update bot for opensearch-py #667

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added an automated api update bot for opensearch-py #664

Added an automated api update bot for opensearch-py #664

saimedhi commented Jan 31, 2024 •

edited

Loading

codecov bot commented Jan 31, 2024 •

edited

Loading

saimedhi commented Jan 31, 2024 •

edited

Loading

saimedhi commented Jan 31, 2024

VachaShah commented Feb 1, 2024

saimedhi commented Feb 1, 2024

VachaShah Feb 1, 2024

saimedhi Feb 1, 2024

dblock Feb 2, 2024 •

edited

Loading

saimedhi Feb 2, 2024

dblock Feb 5, 2024

saimedhi commented Feb 1, 2024

saimedhi commented Feb 2, 2024

VachaShah commented Feb 2, 2024

saimedhi commented Feb 2, 2024

dblock Feb 2, 2024

dblock commented Feb 5, 2024

Added an automated api update bot for opensearch-py #664

Added an automated api update bot for opensearch-py #664

Conversation

saimedhi commented Jan 31, 2024 • edited Loading

Description

Issues Resolved

codecov bot commented Jan 31, 2024 • edited Loading

Codecov Report

saimedhi commented Jan 31, 2024 • edited Loading

saimedhi commented Jan 31, 2024

VachaShah commented Feb 1, 2024

saimedhi commented Feb 1, 2024

VachaShah Feb 1, 2024

Choose a reason for hiding this comment

saimedhi Feb 1, 2024

Choose a reason for hiding this comment

dblock Feb 2, 2024 • edited Loading

Choose a reason for hiding this comment

saimedhi Feb 2, 2024

Choose a reason for hiding this comment

dblock Feb 5, 2024

Choose a reason for hiding this comment

saimedhi commented Feb 1, 2024

saimedhi commented Feb 2, 2024

VachaShah commented Feb 2, 2024

saimedhi commented Feb 2, 2024

dblock Feb 2, 2024

Choose a reason for hiding this comment

dblock commented Feb 5, 2024

saimedhi commented Jan 31, 2024 •

edited

Loading

codecov bot commented Jan 31, 2024 •

edited

Loading

saimedhi commented Jan 31, 2024 •

edited

Loading

dblock Feb 2, 2024 •

edited

Loading