# graphql-vigilant-bot

**Repository Path**: mirrors_Shopify/graphql-vigilant-bot

## Basic Information

- **Project Name**: graphql-vigilant-bot
- **Description**: Github Bot to find breaking changes in your schema.graphql
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-28
- **Last Updated**: 2026-03-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 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
```bash
npm install
npm start
```

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

```bash
docker build -t graphql-vigilant-bot .
docker run --env-file ./.env -p 7010:7010 graphql-vigilant-bot
```
Or use `docker-compose`:
```bash
docker-compose up
```

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

You can also deploy directly to Heroku:

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## 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:
```bash
./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
 >
 > ![demo-1](./image/demo-image-1.png)
 
 > Breaking Changes
 > 
 > ![demo-2](./image/demo-image-2.png)