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
[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
repo2 repository will show up in this Column.
This bot uses normal Project Board note cards with Markdown formatting for configuration.
- Automation Cards are identified by the string
###### Automation Rulesthat has to be used in the note text
- The automation card must be at any the top or bottom of a column (but they tend to end up at the bottom as new cards are added at the top automatically)
- There can be multiple automation cards per column, but you will probably not need that (unless you have many rules or add items from many repositories)
- An automation card can contain other text besides the headline and rules if you really need it to (but best avoid other lists to confuse the parser)
- Rules have to be listed in an unnumbered list in the Automation Card
- This list can contain as many rules as you like
- The rule (see list below) should to be wrapped in ` like so:
- Rule Parameters should be wrapped in
- `example_rule` **param 1** **param 2**
- Items are added or moved into the column when any of the rules in the list are triggered. (It is currently not possible to use boolean logic to combine any rules.)
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 edited
assigned_issue: When an Issue is assigned to a user (but was not before)
assigned_to_issue: When an Issue is assigned to a specific user
unassigned_issue: When an Issue is no longer assigned to a user
milestoned_issue: When an Issue is added to a Milestone
demilestoned_issue: When an Issue is removed from a Milestone
closed_issue: When an Issue is closed
reopened_issue: When an Issue is reopened
assigned_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 user
added_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 request
merged_pullrequest: When a Pull Request is merged
closed_pullrequest: When a Pull Request is closed
reopened_pullrequest: When a Pull Request is reopened
added_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)
- Not finding the event you would like? Just create a new Issue in this Repository!