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

Added an optional DEVELOPER_GUIDE tool #10132

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dtaivpp
Copy link

@dtaivpp dtaivpp commented Sep 20, 2023

Description

Added optional tool SDKMan in DEVELOPER_GUIDE to simplify JDK environment installation and sourcing.

Related Issues

Resolves #[Issue number to be closed when this PR is merged]
N/A

Check List

  • 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.

@github-actions
Copy link
Contributor

Compatibility status:

Checks if related components are compatible with change 89a9011

Incompatible components

Incompatible components: [https://github.com/opensearch-project/security-analytics.git]

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/performance-analyzer.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/neural-search.git]

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

  • RESULT: UNSTABLE ❕
  • TEST FAILURES:
      1 org.opensearch.remotestore.SegmentReplicationUsingRemoteStoreIT.testDeleteOperations

@codecov
Copy link

codecov bot commented Sep 20, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.10%. Comparing base (d7aa6dd) to head (89a9011).
Report is 813 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main   #10132      +/-   ##
============================================
+ Coverage     71.02%   71.10%   +0.08%     
- Complexity    58078    58088      +10     
============================================
  Files          4825     4825              
  Lines        274032   274101      +69     
  Branches      39930    39946      +16     
============================================
+ Hits         194628   194906     +278     
+ Misses        63067    62802     -265     
- Partials      16337    16393      +56     

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

@@ -74,6 +74,35 @@ Fork [opensearch-project/OpenSearch](https://github.com/opensearch-project/OpenS

### Install Prerequisites


### [Optional] sdkman
Copy link
Member

Choose a reason for hiding this comment

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

Add to TOC please.

I think you can make this section "SDKman" to make it consistent capitalization-wise and just say "We recommend a tool such as SDKman to manage JDKs".

@@ -74,6 +74,35 @@ Fork [opensearch-project/OpenSearch](https://github.com/opensearch-project/OpenS

### Install Prerequisites


### [Optional] sdkman
Copy link
Contributor

Choose a reason for hiding this comment

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

We also need to change this to heading 4 (i.e. #### instead of ###)

@BhumikaSaini-Amazon
Copy link
Contributor

We should also change the PR title to be imperative style (i.e. Add an optional DEVELOPER_GUIDE tool instead of Added ...) because the title will be used as the commit message on merge

@opensearch-trigger-bot
Copy link
Contributor

This PR is stalled because it has been open for 30 days with no activity.

@opensearch-trigger-bot opensearch-trigger-bot bot added the stalled Issues that have stalled label Nov 13, 2023
@ticheng-aws
Copy link
Contributor

Hi @dtaivpp, Is this being worked upon? Feel free to reach out to maintainers for further reviews.

@dtaivpp
Copy link
Author

dtaivpp commented Jan 6, 2024

@ticheng-aws sorry for the delay I’ll get these changes in.

@ticheng-aws ticheng-aws added the enhancement Enhancement or improvement to existing feature or request label Jan 6, 2024
@opensearch-trigger-bot opensearch-trigger-bot bot removed the stalled Issues that have stalled label Jan 8, 2024
@opensearch-trigger-bot
Copy link
Contributor

This PR is stalled because it has been open for 30 days with no activity.

@opensearch-trigger-bot opensearch-trigger-bot bot added the stalled Issues that have stalled label Feb 12, 2024
@sohami
Copy link
Collaborator

sohami commented Feb 14, 2024

@dtaivpp Checking again if you plan to clean this up ?

@opensearch-trigger-bot opensearch-trigger-bot bot removed the stalled Issues that have stalled label Feb 17, 2024
@opensearch-trigger-bot
Copy link
Contributor

This PR is stalled because it has been open for 30 days with no activity.

@opensearch-trigger-bot opensearch-trigger-bot bot added stalled Issues that have stalled and removed stalled Issues that have stalled labels Mar 24, 2024
@opensearch-trigger-bot
Copy link
Contributor

This PR is stalled because it has been open for 30 days with no activity.

@opensearch-trigger-bot opensearch-trigger-bot bot added stalled Issues that have stalled and removed stalled Issues that have stalled labels Apr 24, 2024
@sandeshkr419
Copy link
Contributor

@dtaivpp Are you still working on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement or improvement to existing feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants