PF-1924: Add an action to run spotlessApply

[yuhuyoyo]

No description provided.

[melissachang]

I don't understand the problem. Our repo is configured so that you can't merge if spotlessCheck fails.

First, lint-and-static-analysis runs ./gradlew spotlessCheck:

Second, the run test task runs spotlessApply:

[yuhuyoyo]

for some reason it has broken before. Dex may be able to speak more about why but he recently had to manually do a spotlessapply and that PR has hundreds of files.

[melissachang]

I still have the questions I asked on Aug 24. @dexamundsen , how did you generate your formatting PR?

I also have the same questions that I had for #1938. This GHA is highly unusual. Usually for a formatting PR:

1. Someone runs formatting command
2. Someone sends PR with just output from formatting command

The output of the normal process and the output of this action (the resulting PR) are the same. There are many kids of PRs where you do one thing, then you send out a PR for review. We don't create actions for all those things. I don't understand the benefit of this action.

[yuhuyoyo]

I still have the questions I asked on Aug 24. @dexamundsen , how did you generate your formatting PR?

#301
this is the PR I'm referring to.

I also have the same questions that I had for #1938. This GHA is highly unusual. Usually for a formatting PR:

1. Someone runs formatting command
2. Someone sends PR with just output from formatting command

The output of the normal process and the output of this action (the resulting PR) are the same. There are many kids of PRs where you do one thing, then you send out a PR for review. We don't create actions for all those things. I don't understand the benefit of this action.
maybe they all should be automated. My principle here is that if it's not reviewable, it shouldn't need to get reviewed. And a human created PR should be reviewed.

I didn't look at the 186 files to stamp it. So this kind of PR that can be done automatically shouldn't require human action. i could accidentally get some exploration changes into this PR and no one would notice it (186 files!) Google has those bots that generate PR to clean up dead code, etc. This is not a frequent thing. If spotlessCheck passes, nothing will be done.

[dexamundsen]

Apologies for the delayed response - on PR #301 -> I set the TDE to use google formatting and applied formatting manually (right click, format). Since the gradle build (both local and as part of PR) did not change any further files, did not second guess the IDE applied formatting

[melissachang]

Apologies for the delayed response - on PR #301 -> I set the TDE to use google formatting and applied formatting manually (right click, format). Since the gradle build (both local and as part of PR) did not change any further files, did not second guess the IDE applied formatting

Ah, that's not the usual way we do formatting. As I said on Aug 24, we run spotlessApply/spotlessCheck on all code before merging. We don't need an action to run spotlessApply. It would do nothing, since spotlessApply was already run on the code.

FYI - google-java-format produces slightly different results from spotlessApply. If you want Intellij to run spotlessApply instead of google-java-format, here's how.