https://github.com/la3rence/opsbot

A serverless robot manages your issues or pull requests from GitHub repo by comments out of the box.
https://github.com/la3rence/opsbot

ci github github-client robot serverless webhook

Last synced: 8 months ago
JSON representation

A serverless robot manages your issues or pull requests from GitHub repo by comments out of the box.

• Host: GitHub
• URL: https://github.com/la3rence/opsbot
• Owner: la3rence
• License: mit
• Created: 2021-01-21T06:44:45.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2025-04-07T09:24:28.000Z (9 months ago)
• Last Synced: 2025-04-07T10:28:14.384Z (9 months ago)
• Topics: ci, github, github-client, robot, serverless, webhook
• Language: Go
• Homepage: https://go.lawrenceli.me/deploy-opsbot
• Size: 122 KB
• Stars: 9
• Watchers: 1
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# OpsBot 🤖️

[![Test](https://github.com/Lonor/OpsBot/actions/workflows/test.yaml/badge.svg)](https://github.com/Lonor/OpsBot/actions/workflows/test.yaml)

[![codecov](https://codecov.io/gh/Lonor/OpsBot/branch/main/graph/badge.svg?token=H16BEN675E)](https://codecov.io/gh/Lonor/OpsBot)

A robot based on GitHub sdk

and [Vercel's Serverless Function (Go)](https://vercel.com/docs/runtimes#official-runtimes/go). It acts like

the [Kubernetes Prow Robot](https://github.com/k8s-ci-robot). The robot manages your GitHub repo's issues and pull

requests by the content of comments that the user sends.

This project is just getting start and is a toy tool now. For the effectiveness, you can check out any issue or pr from

this repo. If you're interested in this stuff as well, issues or pull requests are welcomed.

## Roadmap / Usage

- [x] `/label [label-name]`    Add a label to the issue / PR

- [x] `/un-label [label-name]` Remove label from the issue / PR

- [x] `/close`                 Close issue / PR

- [x] `/reopen`                Reopen issue / PR

- [x] `/approve`               Approve the PR

- [x] `/lgtm`                  Merge the PR with rebase

- [x] `/update`                Update the PR by merging target branch to source PR branch

- [ ] `/test`                  Test the PR with continuous integration

- [ ] `/assign [username]`     Assign the issue / PR to the user

Once every command accepted by bot, there'll be a 👍 reaction shows in the comment.

## Deployment

[![Deploy with Vercel](https://vercel.com/button)](https://go.lawrenceli.me/deploy-opsbot)

Register a new GitHub account (as the robot)

and [create its personal access token](https://github.com/settings/tokens/new). Don't forget to config the `BOT_TOKEN`

and the `WEBHOOK_SECRET` as the production environment variable and invite it as your repo's collaborator for code access.

After all set up, a new URL will be generated and you can deploy the bot to your repo.

Go to GitHub Repository -> Settings -> WebHook. Add a new WebHook, check `application/json`

and choose all events(or events you care about). Input Payload URL (WebHook Serverless Function API) provided by Vercel,

such as `https://your-username.vercel.app/api/index`. Protect this webhook by using secret with the same string of 

`WEBHOOK_SECRET`.

For more information you can [contact the author](https://go.lawrenceli.me/contact) or open an issue.

## License

MIT