README.md

Funnel

A little CI service that makes sure your pull request is ready according to the git practices of your team.

Using funnel on a project

1. Visit the Funnel app listing: https://github.com/apps/funnel

2. Click Configure

3. Select the organization and project(s) you want to use Funnel on

4. Go to https://funnel-c5.herokuapp.com/repositories to configure your repositories.

That's it! 😄 Now, funnel will check and watch open pull requests to see if they are ready for merging. It can check to see if your PR is squashed into a single commit, rebased on the base branch, or both!

Developing

Local Setup

To start your Phoenix server:

• Install dependencies with mix deps.get
• Create and migrate your database with mix ecto.create && mix ecto.migrate
• Install Node.js dependencies with cd assets && npm install

Now you can visit localhost:4000 from your browser.

Environment

See .envrc-sample for en example.

source .envrc

Running

Start Phoenix server with mix phx.server

Testing

mix test

Deploying

git push heroku master

See it live at https://funnel-c5.herokuapp.com.

References

GitHub API

• GitHub App Auth Strategy
• GitHub App API
• GitHub App Installations API