entria / graphql-vigilant-bot

Github Bot to find breaking changes in your schema.graphql

GraphQLVigilantBot

Installation

First clone this repository, then check .env.example for which environment variables you need to set before running this bot. We recommend you to create a new GitHub account for your bot, which is going to be used to author the comments.

Now run

npm install
npm start

Using Docker

A Dockerfile is also provided, you can use it to run the bot:

docker build -t graphql-vigilant-bot .
docker run --env-file ./.env -p 7010:7010 graphql-vigilant-bot

Or use docker-compose:

docker-compose up

The bot will be available at http://localhost.

You can also deploy directly to Heroku:

Setup

You need to add a webhook pointing to this bot, use application/json as the Content Type, and select the Pull request event. Make sure to set a secret, and keep note of it, you will need to add it to your .env file.

Development

Since this bot depends on Github webhooks, we gonna need to use ngrok to redirect the webhook request to our machine.

Run:

./ngrok http $PORT

Where $PORT is the port you are going to run the bot.

Grab the *.ngrok.io URL and add it as webhook on your repo.

How it looks like

Syntax Errors

Breaking Changes

graphql-vigilant-bot's Issues

Add docker

Add tests

Breaking Changes

Hi,

How can I view the breaking changes?

I try in http://localhost:7010/ and the respose is: Not Found

Thanks a lot!!

Add deploy to Heroku button