search

opensearch-project / custom-codecs

OpenSearch custom lucene codecs for providing different on-disk index encoding (e.g., compression).
Apache License 2.0
6 stars 13 forks source link

Add spotless for formatting Java source files #120

Closed mulugetam closed 3 months ago

mulugetam commented 3 months ago

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.

reta commented 3 months ago

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

mulerm commented 3 months ago

@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 commented 3 months ago

@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

mulugetam commented 3 months ago

@reta Fixed. Please review.

opensearch-trigger-bot[bot] commented 3 months ago

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 commented 3 months ago

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