Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

A bot to help manage Ballet projects
https://github.com/ballet/ballet-bot

bot github-app probot-app

Last synced: about 1 month ago
JSON representation

A bot to help manage Ballet projects

Host: GitHub
URL: https://github.com/ballet/ballet-bot
Owner: ballet
License: isc
Created: 2019-04-18T18:37:11.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-02-28T15:42:53.000Z (almost 2 years ago)
Last Synced: 2023-08-04T16:13:35.039Z (over 1 year ago)
Topics: bot, github-app, probot-app
Language: JavaScript
Homepage: https://github.com/apps/ballet-bot
Size: 1.73 MB
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 28
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

![Uptime Status](https://img.shields.io/uptimerobot/status/m784006190-b0fa1300848e931654e56628)
[![Run Tests](https://github.com/ballet/ballet-bot/workflows/Test/badge.svg)](https://github.com/ballet/ballet/actions?query=workflow%3A%22Test%22)

# Ballet Bot

> A GitHub App built with [Probot](https://github.com/probot/probot)

Ballet Bot is a bot (GitHub App) to help manage [Ballet](https://ballet.github.io) projects.

Ballet projects are collaborative projects to produce a shared data science artifact, like a feature engineering pipeline. They receive many small contributions (data science patches) from collaborators. In traditional software development, a patch, like a pull request on GitHub, may be subjected to a code review by a maintainer or another committer on the project. In the case of Ballet projects, since each patch is expected to follow the same structure, it can be largely validated without the need for a manual code review.

Building off this, Ballet Bot allows pull request management tasks to be automated in the context of a Ballet project. More specifically, Ballet Bot can detect for a pull request whether the patch has validated successfully or not, and can automatically merge PRs corresponding to "good" patches and close PRs corresponding to "bad" patches. In addition, if the result of patch validation is that [some other patch should be pruned](https://ballet.github.io/ballet/maintainer_guide.html#pruning-features), then Ballet Bot can automatically remove the other patch from the repository, either by committing directly to the default branch or by creating a new PR.

## Configuration

Ballet Bot reads configuration from a projects `ballet.yml` configuration file. The following options are supported under the `github` key:

* `pruning_action`: what action to take when the feature validation routine identifies a feature that should be pruned, one of `no_action`, `make_pull_request`, and `commit_to_master`
* `auto_merge_accepted_features`: whether to automatically merge pull requests that introduce features that validate successfully, one of `no` and `yes`
* `auto_close_rejected_features`: whether to automatically close pull requests that introduce features that fail to validate, one of `no` and `yes`

Here is an example snippet from a `ballet.yml` file:

```yml
github:
pruning_action: commit_to_master
auto_merge_accepted_features: yes
auto_close_rejected_features: yes
```

## Development

### Setup

```sh
# Install dependencies
npm install

# Run the bot
npm start
```

### Contributing

If you have suggestions for how Ballet Bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the [Contributing Guide](CONTRIBUTING.md).

## License