Added ability to add comments

[adangel]

I tested this now, but unfortunately no comments are created for me. Did you have any success?

I don't see any output from octokit, so I'm not even sure, whether the POST request is executed at all.

Possible problems:

• creating issue comments requires write permission. A PR from a forked repository only has read permissions (see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions ).
• The default token, that is generated for a action, might not necessarily work for that reason.
• Since we use the token now also to create comments, we should probably update the documentation for the token parameter (it's now not only used for "analyzeModifiedFilesOnly").
• Executing the POST Requests locally with curl with my own PAT works. (Note: I added some logging in https://github.com/pmd/pmd-github-action/commit/d80fd9479bd638accbc94674bf4449d6ddfe2e46 and https://github.com/pmd/pmd-github-action/commit/efcf6fa3ec3e8a865d110597a3953398d03b1021). So, the general data should be fine, but since Octokit doesn't log anything at all...
• I tried around a bit with await/async, since the request is a promise and is executed asynchrounously, so it might happen, that the request are not executed before the action finishes. But that didn't change anything (https://github.com/pmd/pmd-github-action/commit/60d1c0e3f038880f52797261e54d2bbfe96e5a09, https://github.com/pmd/pmd-github-action/commit/29996a59f7d5d6ad33c4c379a62335fabe9ec296, https://github.com/pmd/pmd-github-action/commit/1462bb4518b1ed23795561cad4877fe25d7bb4f4)
• See https://github.com/pmd/pmd-github-action-tests/pull/15 for the last Test PR (which is from the same repo, so it indeed has write access to create comments).
  • build output: https://github.com/pmd/pmd-github-action-tests/actions/runs/7569416067/job/20612658017#step:4:221

    About to create 1 comments now for PR #15
    ##[debug]POST /repos/pmd/pmd-github-action-tests/issues/15/comments with {"owner":"pmd","repo":"pmd-github-action-tests","issue_number":15,"body":":heavy_exclamation_mark: (2) - AvoidCatchingThrowableSample.java (Line:5)\n:heavy_exclamation_mark: (2) - AvoidCatchingThrowableSample.java (Line:12)"}
    Finished creating comments.

• Test procedure: https://github.com/pmd/pmd-github-action-tests/tree/java#pull-request-with-comments

[constantine-prokopenko-vrp]

Many thanks for your investigation. I'll close the PR for now. I'll reopen PR once I resolve all the issues.