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

Deprecate public methods and variables that contain 'master' terminology in 'client' directory #3966

Merged
merged 2 commits into from
Jul 22, 2022

Conversation

tlfeng
Copy link
Collaborator

@tlfeng tlfeng commented Jul 21, 2022

Description

To support inclusive language, the master terminology is going to be replaced by cluster manager in the code base.
This PR deprecate public and protected methods/variable that contains master terminology in the name in client directory, and create alternatives.

List of public methods to be renamed in client directory:

public void setMasterTimeout(TimeValue clusterManagerTimeout)
public TimeValue masterNodeTimeout()
public TimeValue getMasterNodeTimeout()
public void setMasterNodeTimeout(@Nullable TimeValue clusterManagerNodeTimeout)
public void setMasterNodeTimeout(String clusterManagerNodeTimeout)
public boolean isMasterEligible()

List of public variables to be renamed in client directory:

public static final TimeValue DEFAULT_MASTER_NODE_TIMEOUT

Other changes:

Issues Resolved

A part of #3544

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.

…ogy in 'client' directory

Signed-off-by: Tianli Feng <[email protected]>
@tlfeng tlfeng requested review from a team and reta as code owners July 21, 2022 05:24
@tlfeng tlfeng added backport PRs or issues specific to backporting features or enhancments v3.0.0 Issues and PRs related to version 3.0.0 backport 2.x Backport to 2.x branch v2.2.0 enhancement Enhancement or improvement to existing feature or request deprecate labels Jul 21, 2022
@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

@github-actions
Copy link
Contributor

Gradle Check (Jenkins) Run Completed with:

@tlfeng
Copy link
Collaborator Author

tlfeng commented Jul 21, 2022

@Rishikesh1159 Thank you so much for your review! 👍

@tlfeng tlfeng merged commit ccf1d15 into opensearch-project:main Jul 22, 2022
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-3966-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 ccf1d15618770acd54be9b3f37e731612a42e2d6
# Push it to GitHub
git push --set-upstream origin backport/backport-3966-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-3966-to-2.x.

@tlfeng tlfeng deleted the deprecate-master-method-client branch July 22, 2022 05:58
@opensearch-project opensearch-project deleted a comment from github-actions bot Jul 22, 2022
tlfeng pushed a commit to tlfeng/OpenSearch that referenced this pull request Jul 22, 2022
…ogy in 'client' directory (opensearch-project#3966)

* Deprecate public methods and variables that contain 'master' terminology in 'client' directory

Signed-off-by: Tianli Feng <[email protected]>

* Change 1 String type usages with 'master' to 'cluster manager'

Signed-off-by: Tianli Feng <[email protected]>
tlfeng pushed a commit that referenced this pull request Jul 26, 2022
…ogy in 'client' directory (#3966) (#3981)

To support inclusive language, the `master` terminology is going to be replaced by `cluster manager` in the code base.
This PR deprecate public and protected methods/variable that contains `master` terminology in the name in client directory, and create alternatives.

List of public methods to be renamed in client directory:
```
public void setMasterTimeout(TimeValue clusterManagerTimeout)
public TimeValue masterNodeTimeout()
public TimeValue getMasterNodeTimeout()
public void setMasterNodeTimeout(@nullable TimeValue clusterManagerNodeTimeout)
public void setMasterNodeTimeout(String clusterManagerNodeTimeout)
public boolean isMasterEligible()
```

List of public variables to be renamed in client directory:
```
public static final TimeValue DEFAULT_MASTER_NODE_TIMEOUT
```

Signed-off-by: Tianli Feng <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport PRs or issues specific to backporting features or enhancments backport 2.x Backport to 2.x branch deprecate enhancement Enhancement or improvement to existing feature or request v2.2.0 v3.0.0 Issues and PRs related to version 3.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants