This is fork repository. Original is popuko.
frau is a very cute and useful GitHub bot.
She can do as follows:
- merge a pull request automatically
- assign someone to review a pull request
- check if a pull request is mergeable
To just go for it is student rights, we decided to introduce bots and services to our projects.
frau is one of our projects and tries. She makes our development process useful. At first, we were going to use bors, or popuko as it is, however, we wanted more experience and incentive. And we thought some features we needed weren't suitable for popuko's policy. Therefore, we forked popuko and started to develop.
Almost features are based on popuko, see popuko's features and frau's CHANGELOG.
Please get binary from here or build by yourself.
- This requires that
Go
andGit
have been installed. - Build from the source. Run these steps:
git clone https://github.com/naxa-jp/frau.git
cd frau && go build
- Create the config directory.
- By default, this app uses
$XDG_CONFIG_HOME/frau/
as the config dir. (If you don't set$XDG_CONFIG_HOME
environment variable, this use~/.config/frau/
.) - You can configure the config directory by
--config-base-dir
- By default, this app uses
- Set
config.toml
to the config directory.- Let's copy from
./example.config.toml
- Let's copy from
- Start the exec binary.
- This app dumps all logs into stdout & stderr.
- If you'd like to use TLS, then provide
--tls
,--cert
, and--key
options.
- Set the account (or the team which it belonging to) which this app uses as a collaborator for your repository (requires write priviledge).
- Add
OWNERS.json
file to the root of your repository.- Please see
OwnersFile
about the detail. - The example is here.
- Please see
- Set
http:https://<your_server_with_port>/github
for the webhook to your repository with these events:Check suites
(required to use Auto-Merging feature (GitHub App CI Services))Issue comments
Pull requests
(required to remove all status (S-
prefixed) labels after a pull request is closed)Pull request reviews
(required tor+
PRs via reviews)Pushes
Statuses
(required to use Auto-Merging feature (non GitHub App CI services))
- Create these labels to make the status visible.
S-awaiting-review
- for a pull request assigned to some reviewer.
S-awaiting-merge
- for a pull request queued to this bot.
S-needs-rebase
- for an unmergeable pull request.
S-fails-tests-with-upstream
- for a pull request which fails tests after try to merge into upstream (used by Auto-Merging feature).
S-do-not-merge
- for a pull request not to want to merge
- Enable to start the build on creating the branch named
auto
for your CI service (e.g. TravisCI).- You can configure this branch's name by
OWNERS.json
.
- You can configure this branch's name by
- Done!
We welcome your contributing, thanks!
See CONTRIBUTING.md