PR-actions workflow with support for /fix:format

[chalin]

• A first attempt at a comment-triggerable bot action to reformat files in a PR.
• Contributes to Make build and CI more contributor friendly #2448

[chalin]

Dunno if it'll trigger on this PR. Here goes ...
/fix:format

Edit: it didn't trigger. Maybe it needs to be merged first?

[chalin]

Hey @trask: what's the best way to test & debug new GH actions (that trigger on comments) like the one in this PR?

[trask]

push the PR to the main branch on your fork, then open a PR on your fork (targeting main on your fork as opposed to targeting the otel repo), then comment on that PR

btw, we have similar here: https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/.github/workflows/comment-driven-automation.yml

the problem which I don't have solution for yet is that when it pushes the commit back to the PR, it doesn't trigger workflow, and the only way to trigger workflow is to manually close and re-open the PR, e.g. open-telemetry/opentelemetry-java-instrumentation#7881 (comment)

[chalin]

Oh, very cool that y'all have a script like that already. Thanks for guidance @trask, and the heads up regarding the (non-)triggering issue.

[chalin]

@cartermp @svrnm (cc @trask): this is ready for review. It's a first cut, but it's functional.

I tested it from another repo. As mentioned in Commits made by this Action do not trigger new Workflow runs:

The resulting commit will not trigger another GitHub Actions Workflow run.

But we can always manually re-trigger the "Check format" action. Maybe we'll find a better solution down the line.

[cartermp]

Let's go with this for now and we can adjust if needed!

[chalin]

@cartermp - FYI, I've tested the workflow and it goes through all the paces but the pushed commit doesn't make it back into the PR 🤷🏼‍♂️. I'll investigate as soon as I can, but it might not be until late next week.

[chalin]

@cartermp - hey, it did work! Just took longer than I expected 🤷🏼‍♂️.