Automatically add and move Issues/Pull Requests on a Project board
MIT License
Do you like the idea of GitHub's Project Automation feature but find it lacking?
This bot will automatically add new Issues or Pull Requests to a Project board based on specially formatted Cards in each Column of a Project. It also allows you to customize the rules for moving Issues between Columns.
Go to the project-bot GitHub App page and click [Install]
(or [Configure]
if you already installed it) to have it run on Public Project Boards.
To see what it looks like, you can look at the GitHub projects for this repository.
To create an Automation Card, create a Card in a Project like this:
###### Automation Rules
<!-- Documentation: https://github.com/philschatz/project-bot -->
- `assigned_issue`
- `closed_issue`
- `added_label` **wontfix**
- `new_pullrequest` **repo1** **repo2**
Now, whenever any Issue that is assigned, or closed, or a wontfix
label is added, or a new Pull Request is opened on the repo1
or repo2
repository will show up in this Column.
This bot uses normal Project Board note cards with Markdown formatting for configuration.
###### Automation Rules
that has to be used in the note text- `example_rule`
**
like so:
- `example_rule` **param 1** **param 2**
The following rules can be included in automation cards:
To add items to the project board, you have these two rules:
new_issue
: When an Issue is created (optionally, a space-separated set of repo names)new_pullrequest
: When a Pull Request is created (optionally, a space-separated set of repo names)After an item has been added to a project board (manually or by the previous rules) it can be moved to another column by one of the following rules:
edited_issue
: When an Issue is editedassigned_issue
: When an Issue is assigned to a user (but was not before)assigned_to_issue
: When an Issue is assigned to a specific userunassigned_issue
: When an Issue is no longer assigned to a usermilestoned_issue
: When an Issue is added to a Milestonedemilestoned_issue
: When an Issue is removed from a Milestoneclosed_issue
: When an Issue is closedreopened_issue
: When an Issue is reopenedassigned_pullrequest
: When a Pull Request is assigned to a user (but was not before)unassigned_pullrequest
: When a Pull Request is no longer assigned to a useradded_reviewer
: (optional username or array of usernames that need to be added)accepted_pullrequest
: When at least one Reviewer Accepted, and there are no Rejections on a Pull requestmerged_pullrequest
: When a Pull Request is mergedclosed_pullrequest
: When a Pull Request is closedreopened_pullrequest
: When a Pull Request is reopenedadded_label
: (requires exactly one argument, the string representing the name of the label)removed_label
: (requires exactly one argument, the string representing the name of the label)