CI: Add Auto-Format GitHub Actions to format Java Files

[SaptarshiSarkar12]

Is your feature request related to a problem? Please describe.

This project has a code style defined in checkstyle.xml file in the checkstyle directory. Checking whether the code in the Pull Requests or branches follows the project's code style and applying fixes accordingly is a tedious work.

Describe the solution you'd like

I want to use OpenRewrite's Gradle Plugin to automatically format the Java files using the Checkstyle configuration. I would also like to create a GitHub Actions to automatically run the formatter and push the changes to the branches or the PRs.

Additional context

I have implemented this feature in an Open-Source project - Drifty and the GitHub Action also pushes the formatted files to the branches or PRs as you can see below 👇

If this issue seems good to the maintainers and adds some value to the project, then, I would like to work on this issue.