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

Clarify JDK requirement in the Developer Guide #1153

Merged
merged 2 commits into from
Sep 1, 2021
Merged

Clarify JDK requirement in the Developer Guide #1153

merged 2 commits into from
Sep 1, 2021

Conversation

tlfeng
Copy link
Collaborator

@tlfeng tlfeng commented Aug 25, 2021

Description

In DEVELOPER_GUIDE.md:

  • Explicitly point out the JDK 8 requirement is for runtime, but not for compiling.
  • Clarify the JAVAx_HOME env variables are for the "backwards compatibility test".
  • Update the requirement for the JAVAx_HOME env variables. (Run BWC test for 1.0 or 1.x branch requires JDK 8 and 14, for main branch requires JDK 8 and 11)

In TESTING.md:

  • Add explanation on how the backwards compatibility tests get the OpenSearch distributions for a specific version.
  • Clarify the requirement for JAVAx_HOME env variables.

Issues Resolved

#1138

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.

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Wrapper Validation success e528fe7

@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed e528fe7

@tlfeng tlfeng added pending backport Identifies an issue or PR that still needs to be backported documentation Improvements or additions to documentation v1.1.0 Issues, PRs, related to the 1.1.0 release v2.0.0 Version 2.0.0 labels Aug 25, 2021
@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Precommit success e528fe7

dblock
dblock approved these changes Aug 25, 2021
View reviewed changes
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

👏

@dblock
Copy link
Member

dblock commented Aug 25, 2021

start gradle check

@tlfeng tlfeng requested a review from adnapibar August 25, 2021 17:48
@opensearch-ci-bot
Copy link
Collaborator

❌   Gradle Check failure e528fe7
Log 425

Reports 425

@tlfeng
Copy link
Collaborator Author

tlfeng commented Aug 25, 2021

In the above log:

* What went wrong:
Execution failed for task ':distribution:bwc:minor:buildBwcLinuxTar'.
> Building 1.0.0 didn't generate expected file /var/CITOOL/workflow/OpenSearch_CI/PR_Checks/Gradle_Check/search/distribution/bwc/minor/build/bwc/checkout-1.0/distribution/archives/linux-tar/build/distributions/opensearch-1.0.0-SNAPSHOT-linux-x64.tar.gz

Haha, seems BWC test is not happy with introducing itself more to people in the documentation. 😉

@tlfeng
Copy link
Collaborator Author

tlfeng commented Aug 26, 2021

start gradle check

@tlfeng
Copy link
Collaborator Author

tlfeng commented Aug 26, 2021

See more detail of the BWC test failure: #1158

@opensearch-ci-bot
Copy link
Collaborator

❌   Gradle Check failure e528fe7
Log 433

Reports 433

@tlfeng
Copy link
Collaborator Author

tlfeng commented Aug 26, 2021

In log 433:

FAILURE: Build completed with 2 failures.

1: Task failed with an exception.
-----------
* What went wrong:
Execution failed for task ':build-tools:integTest'.
> There were failing tests. See the report at: file:///var/CITOOL/workflow/OpenSearch_CI/PR_Checks/Gradle_Check/search/buildSrc/build/reports/tests/integTest/index.html

2: Task failed with an exception.
-----------
* What went wrong:
Execution failed for task ':distribution:bwc:minor:buildBwcLinuxTar'.
> Building 1.0.0 didn't generate expected file /var/CITOOL/workflow/OpenSearch_CI/PR_Checks/Gradle_Check/search/distribution/bwc/minor/build/bwc/checkout-1.0/distribution/archives/linux-tar/build/distributions/opensearch-1.0.0-SNAPSHOT-linux-x64.tar.gz

@tlfeng
Copy link
Collaborator Author

tlfeng commented Aug 27, 2021

start gradle check

@opensearch-ci-bot
Copy link
Collaborator

❌   Gradle Check failure e528fe7
Log 437

Reports 437

@tlfeng
Copy link
Collaborator Author

tlfeng commented Aug 27, 2021

In log 437:

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':distribution:bwc:minor:buildBwcLinuxTar'.
> Building 1.0.0 didn't generate expected file /var/CITOOL/workflow/OpenSearch_CI/PR_Checks/Gradle_Check/search/distribution/bwc/minor/build/bwc/checkout-1.0/distribution/archives/linux-tar/build/distributions/opensearch-1.0.0-SNAPSHOT-linux-x64.tar.gz

@adnapibar
Copy link
Contributor

start gradle check

@opensearch-ci-bot
Copy link
Collaborator

❌   Gradle Check failure e528fe7
Log 438

Reports 438

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Wrapper Validation success 4845482

@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed 4845482

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Precommit success 4845482

@tlfeng
Copy link
Collaborator Author

tlfeng commented Aug 27, 2021

As @adnapibar suggested, I merged the latest commits from main branch, and hope the test could pass.

@tlfeng
Copy link
Collaborator Author

tlfeng commented Aug 27, 2021

start gradle check

@opensearch-ci-bot
Copy link
Collaborator

✅   Gradle Check success 4845482
Log 439

Reports 439

@tlfeng tlfeng mentioned this pull request Aug 30, 2021
Closed
5 tasks
@tlfeng tlfeng merged commit 652cdbd into opensearch-project:main Sep 1, 2021
@tlfeng tlfeng deleted the clarify-jdk-dev-guide branch September 1, 2021 21:15
tlfeng pushed a commit to tlfeng/OpenSearch that referenced this pull request Sep 2, 2021
Clarify JDK requirement in the developer guide (opensearch-project#1153)
a4fb94e 
* Explicitly point out the JDK 8 requirement is for runtime, but not for compiling.
* Clarify the JAVAx_HOME env variables are for the "backwards compatibility test".
* Add explanation on how the backwards compatibility tests get the OpenSearch distributions for a specific version.
Signed-off-by: Tianli Feng <[email protected]>
@tlfeng tlfeng mentioned this pull request Sep 2, 2021
Merged
5 tasks
tlfeng pushed a commit that referenced this pull request Sep 3, 2021
Clarify JDK requirement in the developer guide (#1153) (#1208)
495317f 
* Explicitly point out the JDK 8 requirement is for runtime, but not for compiling.
* Clarify the JAVAx_HOME env variables are for the "backwards compatibility test".
* Add explanation on how the backwards compatibility tests get the OpenSearch distributions for a specific version.
Signed-off-by: Tianli Feng <[email protected]>
@tlfeng tlfeng removed the pending backport Identifies an issue or PR that still needs to be backported label Sep 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dblock dblock dblock approved these changes

@adnapibar adnapibar Awaiting requested review from adnapibar

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation v1.1.0 Issues, PRs, related to the 1.1.0 release v2.0.0 Version 2.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@tlfeng @opensearch-ci-bot @dblock @adnapibar