Skip to content
a very cute and helpful GitHub bot 🍆
Go
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
epic Merge pull request #68 from JohnTitor/overwrite-assignee Mar 24, 2019
input style: Apply gofmt -s Mar 10, 2019
operation Merge pull request #53 from JohnTitor/adjust-import-style Mar 18, 2019
queue Merge pull request #65 from JohnTitor/fix-typo Mar 18, 2019
setting style: Apply gofmt -s Mar 10, 2019
tools [demo] Auto-Merge demo Feb 6, 2017
.editorconfig
.gitignore
CHANGELOG.md
CONTRIBUTING.md
LICENSE.MIT Use the implementation of golang's http.Dir for queue.createAbs() Jan 26, 2017
OWNERS.json minor: Add some members Feb 14, 2019
README.md
example.config.toml minor: Fix typos Feb 14, 2019
go.mod chore: Adjust import style Mar 7, 2019
go.sum
main.go refactor: replace ver with version Mar 27, 2019
server.go Merge pull request #53 from JohnTitor/adjust-import-style Mar 18, 2019
version.go chore(release): bump up to v1.1.0 Mar 28, 2019

README.md

frau

CircleCI Go Report Card

What is this?

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

Motivation

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.

Features

Almost features are based on popuko, see popuko's features and frau's CHANGELOG.

Setup Instructions

Build & Launch the Application

Please get binary from here or build by yourself.

Build process

  1. This requires that Go and Git have been installed.
  2. Build from the source. Run these steps:
    1. git clone https://github.com/student-kyushu/frau.git
    2. cd frau && go build

Launch process

  1. 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
  2. Set config.toml to the config directory.
  3. 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 up for your repository in GitHub

  1. Set the account (or the team which it belonging to) which this app uses as a collaborator for your repository (requires write priviledge).
  2. Add OWNERS.json file to the root of your repository.
  3. Set http://<your_server_with_port>/github for the webhook to your repository with these events:
    • Issue comment
    • Push
    • Status (required to use Auto-Merging feature (non GitHub App CI services)).
    • Check Suite (required to use Auto-Merging feature (GitHub App CI Services)).
    • Pull Request (required to remove all status (S- prefixed) labels after a pull request is closed).
  4. 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
  5. 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.
  6. Done!

License

The MIT License

How to Contribute

We welcome your contributing, thanks!

See CONTRIBUTING.md

You can’t perform that action at this time.