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

Migrating from checkstyle to spotless for formatting #648

Merged
merged 6 commits into from
Oct 4, 2023

Conversation

VachaShah
Copy link
Collaborator

Description

Adding spotless support in this repo in place of checkstyle so that we can get features for checking and applying the formatting using spotless. The rules used here are from the OpenSearch repo. spotlessJavaCheck is now part of the build task making it easier for developers to format their changes.

This PR adds the spotless functionality, makes it part of the build and enforces spotless on 3 modules - json, transport and util along with the samples folder. The commits are divided accordingly.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

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.

…style

Signed-off-by: Vacha Shah <vachshah@amazon.com>
Signed-off-by: Vacha Shah <vachshah@amazon.com>
Signed-off-by: Vacha Shah <vachshah@amazon.com>
Signed-off-by: Vacha Shah <vachshah@amazon.com>
Signed-off-by: Vacha Shah <vachshah@amazon.com>
@VachaShah
Copy link
Collaborator Author

@reta @dblock The next PRs will enable spotless for other modules. LMK what you think of this division!

reta
reta previously approved these changes Oct 3, 2023
Signed-off-by: Vacha Shah <vachshah@amazon.com>
@dblock dblock merged commit 57dc5cf into opensearch-project:main Oct 4, 2023
30 of 31 checks passed
@VachaShah VachaShah added the backport 2.x Backport to 2.x branch label Oct 4, 2023
@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:

# 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
pushd ../.worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-648-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 57dc5cf1e5c2ee01fc33fe0b89e93f653c22adda
# Push it to GitHub
git push --set-upstream origin backport/backport-648-to-2.x
# Go back to the original working tree
popd
# 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-648-to-2.x.

@VachaShah VachaShah deleted the checkstyle-to-spotless branch October 4, 2023 18:23
VachaShah added a commit to VachaShah/opensearch-java that referenced this pull request Oct 11, 2023
…ect#648)

* Adding spotless for checking and fixing formatting and removing checkstyle

Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Making build task depend on spotlessJavaCheck

Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Removing resources and documentation related to checkstyle

Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Running spotless for json, transport and util folders

Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Running spotless for samples

Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Removing commented code

Signed-off-by: Vacha Shah <vachshah@amazon.com>

---------

Signed-off-by: Vacha Shah <vachshah@amazon.com>
dblock pushed a commit that referenced this pull request Oct 12, 2023
…661)

* Migrating from checkstyle to spotless for formatting (#648)

* Adding spotless for checking and fixing formatting and removing checkstyle

Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Making build task depend on spotlessJavaCheck

Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Removing resources and documentation related to checkstyle

Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Running spotless for json, transport and util folders

Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Running spotless for samples

Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Removing commented code

Signed-off-by: Vacha Shah <vachshah@amazon.com>

---------

Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Fixing merge conflicts and build

Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Enabling spotless for all modules from PR 651

Signed-off-by: Vacha Shah <vachshah@amazon.com>

* Applying spotless to all the remaining files

Signed-off-by: Vacha Shah <vachshah@amazon.com>

---------

Signed-off-by: Vacha Shah <vachshah@amazon.com>
@BrendonFaleiro BrendonFaleiro mentioned this pull request Jun 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x Backport to 2.x branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants