https://github.com/open-bot/open-bot

An unopinionated bot driven by a configuration file in the repository.
https://github.com/open-bot/open-bot

Last synced: 19 days ago
JSON representation

An unopinionated bot driven by a configuration file in the repository.

• Host: GitHub
• URL: https://github.com/open-bot/open-bot
• Owner: open-bot
• Created: 2017-03-26T01:35:41.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T18:22:50.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T19:52:08.118Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 1.42 MB
• Stars: 197
• Watchers: 5
• Forks: 37
• Open Issues: 30
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# open-bot

An unopinionated bot driven by a configuration file in the repository.

* Operates on issue/PRs

* Triggered by webhook event or manual batch processing (CLI)

* Rules specify behavior

* Runs on AWS with serverless

## Configuration

* Add the bot's webhook to the webhooks in the repo/org configuration (content type json, events: `Issue comment`, `Issues`, `Pull request`, `Pull request review`, `Pull request review comment`, `Status`)

* Create a `open-bot.yaml` file in the repository root.

* Add the bot name to the yaml file (`bot` property)

* Add rules to the `rules` property (array) see [Rules](doc/rules.md)

## How does it work?

It checks all filters to get the lastest date where the filter matches. If not all filters match it stops here.

For each action it checks if and when the action was already applied. If yes it compares action date if lastest filter date and breaks if action was applied after filter match. Elsewise it runs the action.

This means: It makes sure that actions runs once **after** filters match. If filters match again, actions run again.

## Deploy your own bot

* Clone the repo

* Run `yarn`

* Run `node open-bot configurate` and answer questions

* Run `yarn run deploy-prod` to deploy the bot (takes a while)

  * Note you need to have AWS CLI tools installed and configured. See http://docs.aws.amazon.com/cli/latest/userguide/installing.html

* Run `node open-bot` to gain access to the other tools, i. e. batch processing

## Contributing

### Add new `filters` or `actions`

* Add a file in the folder

* Edit the index.js file

* Test it locally with `node open-bot process some/repo#123 --settings open-bot.yaml --simulate`

* Send a PR

## License

Free for open-source projects.

Get in contact with me if you want to use it for private repos.