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

Jump to bottom

Add comment to XContentBuilder.toString() #13809

Merged
merged 3 commits into from
Jun 3, 2024
Merged

Add comment to XContentBuilder.toString() #13809

merged 3 commits into from
Jun 3, 2024

Conversation

chishui
Copy link
Contributor

@chishui chishui commented May 24, 2024 •
edited by andrross
Loading

Description

Add comments to XContentBuilder.toString() to call out that calling this method could close the builder.

Related Issues

Resolves #13731

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • API changes companion pull request created.
  • Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
  • Commits are signed per the DCO using --signoff
  • Commit changes are listed out in CHANGELOG.md file (See: Changelog)
  • Public documentation issue/PR created

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.

@chishui
Add comment to XContentBuilder.toString
17f01d1 
Signed-off-by: Liyun Xiu <xiliyun@amazon.com>
@chishui
Copy link
Contributor Author

chishui commented May 24, 2024

Changelog is not needed.

@github-actions GitHub Actions
Copy link
Contributor

❕ Gradle check result for 17f01d1: UNSTABLE

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

@codecov Codecov
Copy link

codecov bot commented May 24, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.76%. Comparing base (b15cb0c) to head (e7e736e).
Report is 333 commits behind head on main.

Additional details and impacted files 
@@             Coverage Diff              @@
##               main   #13809      +/-   ##
============================================
+ Coverage     71.42%   71.76%   +0.34%     
- Complexity    59978    61378    +1400     
============================================
  Files          4985     5065      +80     
  Lines        282275   288124    +5849     
  Branches      40946    41719     +773     
============================================
+ Hits         201603   206777    +5174     
- Misses        63999    64278     +279     
- Partials      16673    17069     +396

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

@chishui
Fix typo
5cc0a04 
Signed-off-by: Liyun Xiu <xiliyun@amazon.com>
@github-actions GitHub Actions
Copy link
Contributor

❌ Gradle check result for 5cc0a04: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@github-actions github-actions bot added the Libraries Lucene Upgrades and Libraries, Any 3rd party library that Core depends on, ex: nebula; team is respo label May 24, 2024
@github-actions GitHub Actions
Copy link
Contributor

❌ Gradle check result for 5cc0a04: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@github-actions GitHub Actions
Copy link
Contributor

❌ Gradle check result for 5cc0a04: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@andrross
Copy link
Member

❌ Gradle check result for 5cc0a04: FAILURE

#10006
#13473

@github-actions GitHub Actions
Copy link
Contributor

❌ Gradle check result for 5cc0a04: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 3, 2024

✅ Gradle check result for e7e736e: SUCCESS

@chishui
Copy link
Contributor Author

chishui commented Jun 3, 2024

@dblock the change your requested has been addressed, could you take a look?

@dblock dblock added the backport 2.x Backport to 2.x branch label Jun 3, 2024
@dblock dblock merged commit bf43678 into opensearch-project:main Jun 3, 2024
33 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jun 3, 2024
@github-actions
Add comment to XContentBuilder.toString() (#13809)
1e25052 
* Add comment to XContentBuilder.toString

Signed-off-by: Liyun Xiu <xiliyun@amazon.com>

* Fix typo

Signed-off-by: Liyun Xiu <xiliyun@amazon.com>

---------

Signed-off-by: Liyun Xiu <xiliyun@amazon.com>
(cherry picked from commit bf43678)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Jun 3, 2024
Merged
dblock pushed a commit that referenced this pull request Jun 3, 2024
@opensearch-trigger-bot @github-actions
Add comment to XContentBuilder.toString() (#13809) (#13932)
bd0deec 
* Add comment to XContentBuilder.toString



* Fix typo



---------


(cherry picked from commit bf43678)

Signed-off-by: Liyun Xiu <xiliyun@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>
akolarkunnu pushed a commit to akolarkunnu/OpenSearch that referenced this pull request Jun 5, 2024
@chishui
Add comment to XContentBuilder.toString() (opensearch-project#13809)
6af317b 
* Add comment to XContentBuilder.toString

Signed-off-by: Liyun Xiu <xiliyun@amazon.com>

* Fix typo

Signed-off-by: Liyun Xiu <xiliyun@amazon.com>

---------

Signed-off-by: Liyun Xiu <xiliyun@amazon.com>
parv0201 pushed a commit to parv0201/OpenSearch that referenced this pull request Jun 10, 2024
@chishui @parv0201
Add comment to XContentBuilder.toString() (opensearch-project#13809)
44b9a8d 
* Add comment to XContentBuilder.toString

Signed-off-by: Liyun Xiu <xiliyun@amazon.com>

* Fix typo

Signed-off-by: Liyun Xiu <xiliyun@amazon.com>

---------

Signed-off-by: Liyun Xiu <xiliyun@amazon.com>
This was referenced Jun 13, 2024
Open
Open
@finnegancarroll finnegancarroll mentioned this pull request Jun 14, 2024
Merged
3 tasks
@prudhvigodithi prudhvigodithi mentioned this pull request Jun 18, 2024
Closed
This was referenced Jun 27, 2024
Open
Open
Open
Open
Open
Closed
Open
kkewwei pushed a commit to kkewwei/OpenSearch that referenced this pull request Jul 24, 2024
@opensearch-trigger-bot @github-actions @kkewwei
Add comment to XContentBuilder.toString() (opensearch-project#13809) (o…
0739a20 
…pensearch-project#13932)

* Add comment to XContentBuilder.toString

* Fix typo

---------

(cherry picked from commit bf43678)

Signed-off-by: Liyun Xiu <xiliyun@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>
Signed-off-by: kkewwei <kkewwei@163.com>
wdongyu pushed a commit to wdongyu/OpenSearch that referenced this pull request Aug 22, 2024
@chishui
Add comment to XContentBuilder.toString() (opensearch-project#13809)
3ba473c 
* Add comment to XContentBuilder.toString

Signed-off-by: Liyun Xiu <xiliyun@amazon.com>

* Fix typo

Signed-off-by: Liyun Xiu <xiliyun@amazon.com>

---------

Signed-off-by: Liyun Xiu <xiliyun@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@reta reta reta left review comments

@andrross andrross andrross approved these changes

@dblock dblock dblock approved these changes

@anasalkouz anasalkouz Awaiting requested review from anasalkouz anasalkouz is a code owner

@Bukhtawar Bukhtawar Awaiting requested review from Bukhtawar Bukhtawar is a code owner

@CEHENKLE CEHENKLE Awaiting requested review from CEHENKLE CEHENKLE is a code owner

@dbwiddis dbwiddis Awaiting requested review from dbwiddis dbwiddis is a code owner

@dreamer-89 dreamer-89 Awaiting requested review from dreamer-89

@gbbafna gbbafna Awaiting requested review from gbbafna gbbafna is a code owner

@kotwanikunal kotwanikunal Awaiting requested review from kotwanikunal kotwanikunal is a code owner

@mch2 mch2 Awaiting requested review from mch2 mch2 is a code owner

@msfroh msfroh Awaiting requested review from msfroh msfroh is a code owner

@nknize nknize Awaiting requested review from nknize nknize is a code owner

@owaiskazi19 owaiskazi19 Awaiting requested review from owaiskazi19 owaiskazi19 is a code owner

@Rishikesh1159 Rishikesh1159 Awaiting requested review from Rishikesh1159 Rishikesh1159 is a code owner

@sachinpkale sachinpkale Awaiting requested review from sachinpkale sachinpkale is a code owner

@saratvemulapalli saratvemulapalli Awaiting requested review from saratvemulapalli saratvemulapalli is a code owner

@shwetathareja shwetathareja Awaiting requested review from shwetathareja shwetathareja is a code owner

@sohami sohami Awaiting requested review from sohami sohami is a code owner

@tlfeng tlfeng Awaiting requested review from tlfeng

@VachaShah VachaShah Awaiting requested review from VachaShah VachaShah is a code owner

Assignees
No one assigned
Labels
backport 2.x Backport to 2.x branch bug Something isn't working Libraries Lucene Upgrades and Libraries, Any 3rd party library that Core depends on, ex: nebula; team is respo skip-changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[BUG] XContentBuilder.toString() will close the builder itself
4 participants
@chishui @andrross @reta @dblock