nejczdovc/comment-pr

Github action for commenting in the PR

comment-pr's Issues

Default `GITHUB_TOKEN` permissions may not allow writing to PR

The GITHUB_TOKEN used by this action may not have permission to write to the PR. If that's the case you will see an error like:

Error: Resource not accessible by integration

You can give the the github token extra permissions to allow it to write to the PR. Specifically

permissions:
    pull-requests: write
    # The contents permission is not specifically required for this action, but it's required to checkout the repo, so most people will want it too.
    # contents: read

See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions for more info.

Can't post large comments

PR comments have a max size of 65KB, see

PR body/Issue comments are still stored in MySQL as a mediumblob with a maximum value length of 262,144. This equals a limit of 65,536 4-byte unicode characters.

When I use this action to post giant comments that exceed the limit, they will fail (by definition). Can you think of ways to work around this work? For example, can this action detect the size of the comment and save the comment in a gist or something and then add a PR comment to link to it? Thoughts?

Add file input support

Right now we are supporting message input which is ok for simple comments. But we should extend it to support file reads as well so that workflow file is clean.