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

(CI)Use spotless plugin to format the code to ensure that the format of the submitted code is uniform #11111

Closed
wants to merge 1 commit into from

Conversation

liugddx
Copy link
Contributor

@liugddx liugddx commented Sep 9, 2023

close #11021

What is the purpose of the change

Use spotless plugin to format the code to ensure that the format of the submitted code is uniform

  1. Developers need to execute mvn spotless:check to automatically format the code.
  2. The ci pipeline can add code format verification. If it does not pass, it will fail.

Brief changelog

XX

Verifying this change

XXXX

Follow this checklist to help us incorporate your contribution quickly and easily:

  • Make sure there is a Github issue filed for the change (usually before you start working on it). Trivial changes like typos do not require a Github issue. Your pull request should address just this issue, without pulling in other changes - one PR resolves one issue.
  • Format the pull request title like [ISSUE #123] Fix UnknownException when host config not exist. Each commit in the pull request should have a meaningful subject line and body.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Write necessary unit-test to verify your logic correction, more mock a little better when cross module dependency exist. If the new feature or significant change is committed, please remember to add integration-test in test module.
  • Run mvn -B clean package apache-rat:check findbugs:findbugs -Dmaven.test.skip=true to make sure basic checks pass. Run mvn clean install -DskipITs to make sure unit-test pass. Run mvn clean test-compile failsafe:integration-test to make sure integration-test pass.

@liugddx
Copy link
Contributor Author

liugddx commented Sep 9, 2023

Since the code needs to be formatted, the changes will be large.But the benefits are obvious.

  1. Developers need to execute mvn spotless:check to automatically format the code.
  2. The ci pipeline can add code format verification. If it does not pass, it will fail.

@liugddx
Copy link
Contributor Author

liugddx commented Sep 10, 2023

I can't resolve the conflict between checkstyle and spotless plugin, so I decided to close this pr. The cost of using spotless in nacos is too high.

@liugddx liugddx closed this Sep 10, 2023
@liugddx
Copy link
Contributor Author

liugddx commented Sep 18, 2023

@KomachiSion The rules of spotless conflict with checkstyle. If we use spotless, it is recommended to remove the checkstyle plug-in.

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

Successfully merging this pull request may close these issues.

Use spotless plugin to format the code to ensure that the format of the submitted code is uniform
1 participant