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

Add spotless for formatting Java source files #120

Merged
merged 3 commits into from
Mar 15, 2024

Conversation

mulugetam
Copy link
Contributor

@mulugetam mulugetam commented Mar 15, 2024

Description

  1. Adds spotless for Java code formatting ( ./gradlew spotlessJavaCheck).
  2. Formats existing code.
  3. Updates the deprecated gradle construct plugins.withId('java').

Issues Resolved

Resolves inconsistent code formatting.

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.

	- add spotlessJavaCheck.
	- format existing code.
	- upgrade deprecated gradle constructs.

Signed-off-by: Mulugeta Mammo <mulugeta.mammo@intel.com>
@reta
Copy link
Collaborator

reta commented Mar 15, 2024

@mulugetam we probably need to exclude some binary files (as GA checks fail), thank you.

Signed-off-by: Mulugeta Mammo <mulugeta.mammo@intel.com>
@mulerm
Copy link
Contributor

mulerm commented Mar 15, 2024

@reta Looks to me that ./gradlew check failed because spotless was not applied to files in the .github directory. It should pass now. Not sure what binary files we should exclude.

@reta
Copy link
Collaborator

reta commented Mar 15, 2024

@reta Looks to me that ./gradlew check failed because spotless was not applied to files in the .github directory. It should pass now. Not sure what binary files we should exclude.

Oh I see, thanks @mulugetam , I just briefly looked into failure I thought there are some attempts to format binary files, non issue

build.gradle Show resolved Hide resolved
build.gradle Outdated Show resolved Hide resolved
build.gradle Outdated Show resolved Hide resolved
1) Remove the Elasticsearch attribution in spotless formatter.
2) Use java instead of 'java'.
3) Remove version resolution for jackson.

Signed-off-by: Mulugeta Mammo <mulugeta.mammo@intel.com>
@mulugetam
Copy link
Contributor Author

@reta Fixed. Please review.

@reta reta merged commit 27e925c into opensearch-project:main Mar 15, 2024
17 checks passed
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

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

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/custom-codecs/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/custom-codecs/backport-2.x
# Create a new branch
git switch --create backport/backport-120-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 27e925c183f4c2f5c550204e2eedd2caab7b9811
# Push it to GitHub
git push --set-upstream origin backport/backport-120-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/custom-codecs/backport-2.x

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

@reta
Copy link
Collaborator

reta commented Mar 15, 2024

@mulugetam could you please apply backport to 2.x manually? Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants