Skip to content

TomerFi/auto-me-bot

Repository files navigation

Auto-Me-Bot

Managing a repository can be cumbersome 👷 and tiresome 😫.
Let alone managing multiple repositories used by multiple contributors and bots 😧.

My name is auto-me-bot 🤖 I'm here to take some of the repo management load off your shoulders!

all-handlers-success
Failed Checks all-handlers-fail
Configuration

Place a file 📝 called auto-me-bot.yml in your .github folder 📁 in the repos you want me to help out with.
Check out the documentation to see what else I can do 🤙.

# .github/auto-me-bot.yml
---
pr:
  lifecycleLabels: # this means you I'll label PRs based on the their lifecycle.
  conventionalCommits: # this means I'll enforce conventional commit messages in PRs.
  conventionalTitle: # this means I'll enforce conventional title for PRs.
  signedCommits: # this means I'll make sure all commits in PRs are signed with the 'Signed-off-by' trailer.
  tasksList: # this means I'll verify completion of tasks list in PRs.
  autoApprove: # you can tell about users or bots you trust, and I'll automatically approve their PRs.

When using both the lifecycleLabels and autoApprove, it's advised to keep them separated and in order.
Otherwise, the GitHub's approve event might not make its way to the lifecycle handler, and we might miss a label.

Future Plans
  • Size based labeling for pull requests
  • Automate assignees and reviewers for pull requests
  • Various handlers for event types other than pull_requestpush and and issue event types
  • Repository management capabilities, such as labels creation and settings syncing
Alternatives

Other awesome applications the offer similar handlers as auto-me-bot

Works well with

If you keep your commits conventional,
you can use the version-bumper-action for GitHub, to automate your releases.