feat(CI): Added GitHub Actions to check for code style violations

[SaptarshiSarkar12]

What is the purpose of the change

Closes #13413

Brief changelog

• Added GitHub Actions to check for code style violations.

Checklist

• Make sure there is a GitHub_issue field 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.
• 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.
• Check if is necessary to patch to Dubbo 3 if you are work on Dubbo 2.7
• 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 sample in dubbo samples project.
• Add some description to dubbo-website project if you are requesting to add a feature.
• GitHub Actions works fine on your own branch.
• If this contribution is large, please follow the Software Donation Guide.

[SaptarshiSarkar12]

/format

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.36%. Comparing base (6671012) to head (596aa44).
Report is 308 commits behind head on 3.2.

Additional details and impacted files

@@            Coverage Diff             @@
##              3.2   #13489      +/-   ##
==========================================
- Coverage   70.38%   70.36%   -0.02%     
==========================================
  Files        1606     1606              
  Lines       70002    70002              
  Branches    10099    10099              
==========================================
- Hits        49269    49256      -13     
- Misses      16105    16112       +7     
- Partials     4628     4634       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[SaptarshiSarkar12]

@AlbumenJ I have added a slight tab to break the style of one of the java file to check if the CI actually works.

[SaptarshiSarkar12]

@AlbumenJ I think the workflows don't have read and write permission. You can go to Settings > Actions > general and turn on this option 👇

[SaptarshiSarkar12]

@AlbumenJ I think the workflows don't have read and write permission. You can go to Settings > Actions > general and turn on this option 👇

@AlbumenJ The workflow will fail unless you set these permissions.

[AlbumenJ]

@AlbumenJ I think the workflows don't have read and write permission. You can go to Settings > Actions > general and turn on this option 👇

@AlbumenJ The workflow will fail unless you set these permissions.

Seems it should be changed to scheduled task to scan PRs due to permission limitation. The ASF will not enable write access in PRs due to workflows file can be changed by anyone. So it might be a good idea to switch to other kinds of task.

[SaptarshiSarkar12]

@AlbumenJ Okay, I see. So, do you mean that this workflow should run on schedule and will just check if codestyle is followed?

[AlbumenJ]

@AlbumenJ Okay, I see. So, do you mean that this workflow should run on schedule and will just check if codestyle is followed?

Yes :)

[SaptarshiSarkar12]

@AlbumenJ Okay. Then, what should be the time of the workflow run in UTC timezone (this timezone is followed by GH Actions)? Should I keep it at midnight UTC everyday? You can check and give me a custom cron time from https://crontab.guru/ .

[AlbumenJ]

@AlbumenJ Okay. Then, what should be the time of the workflow run in UTC timezone (this timezone is followed by GH Actions)? Should I keep it at midnight UTC everyday? You can check and give me a custom cron time from https://crontab.guru/ .

Every hour or even 20 mins are both ok

[SaptarshiSarkar12]

Okay @AlbumenJ

[SaptarshiSarkar12]

@AlbumenJ I have added the cron job in the workflow to run at every 20 mins.

[SaptarshiSarkar12]

@AlbumenJ The cron job worked 🎉 - you can check here - https://github.com/SaptarshiSarkar12/dubbo/actions/runs/7330812949

[CrazyHZM]

@SaptarshiSarkar12
When PR is submitted, the existing ci process will automatically execute mvn spotless check due to the execution of mvn install. I can't think of the function of this schedule. The code format is guaranteed because this check is done for every commit.

I have an individual suggestion: add a ci code checkstyle to each submission instead of completing it through schedule.

[SaptarshiSarkar12]

@CrazyHZM Okay. But, I couldn't understand your suggestion. Can you please elaborate?

[SaptarshiSarkar12]

@AlbumenJ Should I add the Check for formatting workflow to Build and Test Schedule also?

[AlbumenJ]

@AlbumenJ Should I add the Check for formatting workflow to Build and Test Schedule also?

I think it can be omitted. Because the scheduled task itself will check the format.

[SaptarshiSarkar12]

@AlbumenJ Should the workflow remain in the Build and test PR workflow? I couldn't understand your words. Can you please elaborate?

[AlbumenJ]

@AlbumenJ Should the workflow remain in the Build and test PR workflow? I couldn't understand your words. Can you please elaborate?

Sorry about that. The workflow of Build and Test Schedule has already contained the check the code style with spotless now.
Maybe in

dubbo/.github/workflows/build-and-test-scheduled-3.2.yml

Line 167 in 05d44ab

run: ./mvnw --batch-mode --no-snapshot-updates -e --no-transfer-progress --fail-fast clean test verify -Pjacoco -Dmaven.wagon.httpconnectionManager.ttlSeconds=120 -Dmaven.wagon.http.retryHandler.count=5 -DskipTests=false -DskipIntegrationTests=false -Dcheckstyle.skip=false -Dcheckstyle_unix.skip=false -Drat.skip=false -Dmaven.javadoc.skip=true -DembeddedZookeeperPath=${{ github.workspace }}/.tmp/zookeeper

[SaptarshiSarkar12]

@AlbumenJ It's okay.

[SaptarshiSarkar12]

@AlbumenJ Please review this PR then. Let me know if any further changes are required.

[SaptarshiSarkar12]

@AlbumenJ I don't think the scheduled check creates summary if linting fails. Can I try adding it?

[AlbumenJ]

@AlbumenJ Please review this PR then. Let me know if any further changes are required.

This PR LGTM

[AlbumenJ]

@AlbumenJ I don't think the scheduled check creates summary if linting fails. Can I try adding it?

Build and Test For PR is enough now. scheduled check is for maintainers.

[SaptarshiSarkar12]

Okay @AlbumenJ. So, can I remove my changes which were made solely for testing the CI (like adding extra spaces)?

[AlbumenJ]

Okay @AlbumenJ. So, can I remove my changes which were made solely for testing the CI (like adding extra spaces)?

Yep

[SaptarshiSarkar12]

Okay @AlbumenJ. Would do it soon.
Thank you!

[SaptarshiSarkar12]

@AlbumenJ I have made the required changes.

[sonarcloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

[AlbumenJ]

LGTM

[AlbumenJ]

@CrazyHZM PTAL

[AlbumenJ]

@SaptarshiSarkar12 Thanks for your contribution :)

[SaptarshiSarkar12]

@AlbumenJ I have a question. What is the full form / meaning of PTAL?
@AlbumenJ @CrazyHZM Thank you for reviewing and merging my PR 😄! I loved working on this project ❤️.

[refeccd]

PTAL Please take a look

[SaptarshiSarkar12]

Okay. Got it. Thank you @liaozan 😄!