With Reviewpad, you can automatically add comments to the pull request.
There are three different mechanisms to add a comment to the pull request:
The difference between the modes is that the
comment action will add a comment every time the action is executed,
commentOnce will add a comment once no matter the amount of times the action is executed, while the other commenting actions are bundled together in a comment which is also automatically updated.
To the use the third set of comments (i.e.
info) you need to enable the
Automatically comment the pull request.
- name: emptyDescription
spec: '$description() == ""'
- name: isFirstTimeContributor
spec: "$pullRequestCountBy($author()) == 1"
- name: welcome-user
description: Welcome user first contribution
- rule: isFirstTimeContributor
# Comment on pull request once
- '$commentOnce("Well done! This is your first contribution.")'
- name: comment-on-empty-description
description: Error on empty descriptions
- rule: emptyDescription
# Add error message to reviewpad report
- '$error("The description of the pull request cannot be empty")'
- name: comment-on-pull-request
description: Example comment on pull request
# Add info message to reviewpad report
- '$info("Thanks for this pull request. @marcelosousa will take a look!")'
# Add warning message to reviewpad report
- '$warn("Please make sure the CI is green before merging.")'
You can see this workflow in action the following pull request.