GitHub Action
Auto assign a reviewer by comment command
v2.1.0
Latest version
- This works as GitHub Actions.
- This assigns a reviewer and change a label by special comment command.
- This behaves like highfive or popuko
- We don't manage any bot instance for this purpose.
- We'd like to use managed service to host this kind of a bot.
- Try GitHub Actions :)
- Investigate its latency & its throughput for chat bot purpose.
- You can use these command as a comment for issue or pull request or pull request review.
- Your comment change some status of the issue you commented.
- This actions treats
S-
prefixed labels exclusively.- e.g. If your pull request is labeled with
S-a
andS-b
, then this action replaces them withS-c
.
- e.g. If your pull request is labeled with
- If your comment has multiple line, this action interprets only the first line of it.
- To support the command style which bors-ng uses, you can write
botname <this action command>
.- e.g.
bors r+
is ok.
- e.g.
- This assigns
@username1
and@username2
to assignees filed. - This adds the label
S-awaiting-review
.
- This assigns the user who opens the issue to assignees filed.
- This adds the label
S-awaiting-merge
.
- This assigns the user who opens the issue to assignees filed.
- This adds the label
S-need-code-change
.
Add this example to your GitHub Actions workflow configuration.
name: assign_review_by_comment by issue_comment
on: [issue_comment, pull_request_review]
jobs:
assign_review_by_comment:
runs-on: ubuntu-latest
steps:
- name: assign_review_by_comment
# We recommend to use an arbitary latest version
# if you don't have any troubles.
# You can also specify `master`, but it sometimes might be broken.
uses: cats-oss/github-action-auto-assign@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- By the Limitation of the current GitHub Actions, this might not works your repository well.
- Because GitHub Actions is still in beta.
- We confirms this works with a private repository. But we have not confirmed yet to work with a public one.
- We know that this action takes ~30sec to react user comment.
- We think this is the current or fundamental limitation of GitHub Actions. See #6.