Home

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 load off your shoulders, just tell me what you want me to do...

Installation⚓︎

Install me from here and select the repos you want me to keep an eye out for.

Events I work with

pull_request
pull_request_review

Permissions I require

scope	permission
.github/auto-me-bot.yml	read
administration	read
checks	write
metadata	read
pull_requests	write

metadata:read is mandatory.

Configuration⚓︎

I take my instructions in yaml.
If I can't find my configuration file in the repo I'm working with, I'll look for it in your .github repo.

.github/auto-me-bot.yml

---
pr:
  lifecycleLabels: # (8)
    ignoreDrafts: false # (9)
    labels: # (10)
      reviewRequired: "waiting for a review"
      changesRequested: "changes were requested"
      moreReviewsRequired: "approved but waiting for more reviews"
      reviewStarted: "a review was started"
      approved: "approved and ready"
      merged: "merged and done"
  conventionalCommits: # (1)
    rules: # (2)
  conventionalTitle: # (11)
    rules: # (12)
  signedCommits: # (3)
    ignore: # (4)
      users: [] # (6)
      emails: [] # (7)
  tasksList: # (5)
  autoApprove: # (13)
    allBots: false
    users: ["dependabot"]

this means I'll enforce conventional commit messages in PRs.
you can optionally configure some rules for me.
see commitlint options
this means I'll make sure all commits in PRs are signed with the 'Signed-off-by' trailer.
you can optionally list users and/or emails for me to ignore.
this means I'll verify the completion of the tasks list in PRs.
list users you want my to ignore.
list email addresses you want my to ignore.
this means you I'll label PRs based on the their lifecycle.
you can optionally instruct me to ignore drafts, my default value for this is false for including drafts.
you don't have to specify all of the lifecycle's stages, just the ones you want.
and I don't create the labels yet, so you'll have to create them.
this means I'll enforce conventional titles for PRs.
you can optionally configure some rules for me.
see commitlint options
you can tell about users or bots you trust, and I'll automatically approve their PRs.

Note

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.

Look-See⚓︎

lifecycle labels - more reviews required

Spec⚓︎

I was built with Probot.
I was documented with Material for MkDocs.
My art, i.e. my logo, was created with DiceBear.
I'm deployed to AWS Lambda.
My docs are deployed to GitHub Pages.
My source code, of course, is stored on GitHub.

License⚓︎

ISC License

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.