Skip to content

Commit

Permalink
Added some notes on the bots that I use
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasbn committed May 16, 2021
1 parent 4572369 commit 8de7653
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 2 deletions.
36 changes: 36 additions & 0 deletions probot/auto-assign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Auto-assign

This GitHub automation is really nice if you want to have reviews and issues auto-assigned.

```yaml
# Set to true to add reviewers to pull requests
addReviewers: true

# Set to true to add assignees to pull requests
addAssignees: true

# A list of reviewers to be added to pull requests (GitHub user name)
reviewers:
- jonasbn

# A list of keywords to be skipped the process that add reviewers if pull requests include it
#skipKeywords:
# - wip

# A number of reviewers added to the pull request
# Set 0 to add all the reviewers (default: 0)
numberOfReviewers: 0

# A list of assignees, overrides reviewers if set
assignees:
- jonasbn

# A number of assignees to add to the pull request
# Set to 0 to add all of the assignees.
# Uses numberOfReviewers if unset.
# numberOfAssignees: 2
```

## Resources and References

- [Probot Website](https://probot.github.io/apps/auto-assign/)
9 changes: 9 additions & 0 deletions probot/delete_merged_branch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Delete Merged Branch

This is a really helpful _bot_, it deletes branches when merged.

Yes, you can restore them, but most often you forget to delete them so this is really helpfull with cleaning out the things that crop up.

## Resources and References

- [Probot Website](https://probot.github.io/apps/delete-merged-branch/)
12 changes: 10 additions & 2 deletions probot/todo.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
# Probot TODO bot

TODO
This _bot_ scans your code for keywords and create issues.

```yaml
todo:
reopenClosed: false
keyword: ["REVIEW", "TODO"]
caseSensitive: true
```

## Resources and References

- [Website](https://probot.github.io/apps/todo/)
- [Probot Website](https://probot.github.io/apps/todo/)
- [GitHub Repository](https://github.com/JasonEtco/todo#configuring-for-your-project)

0 comments on commit 8de7653

Please sign in to comment.