Support reading from body-file #462
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pbrisbin
force-pushed
the
pb/body-from-file
branch
from
9a08f95 to
02a04c7
Compare
Configured rules can now omit `body`, to load comment contents from a
file. The file is read the same way as the configuration: via the GitHub
API and from the default branch.
The file path will conventionally be `.github/commenter/{name}.md`.
If `body-file` is given, that is used as the complete path. If
`body-file-name` is given, `.github/commenter/{body-file-name}` is used.
The prefix is also configurable as `inputs.body-file-prefix`.
If the file does not exist on the default branch, the API call to read
it will error and we allow that error to bubble out as-is. We could
catch and improve the messaging, or gracefully place details of the
failure in the comment itself, but both of these have been deferred by
now. We'll start simply.
pbrisbin
force-pushed
the
pb/body-from-file
branch
from
02a04c7 to
7a71761
Compare
danroyo
approved these changes
Apr 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #122.
Configured rules can now omit
body, to load comment contents from afile. The file is read the same way as the configuration: via the GitHub
API and from the default branch.
The file path will conventionally be
.github/commenter/{name}.md.If
body-fileis given, that is used as the complete path. Ifbody-file-nameis given,.github/commenter/{body-file-name}is used.The prefix is also configurable as
inputs.body-file-prefix.If the file does not exist on the default branch, the API call to read
it will error and we allow that error to bubble out as-is. We could
catch and improve the messaging, or gracefully place details of the
failure in the comment itself, but both of these have been deferred by
now. We'll start simply.