https://github.com/entria/graphql-vigilant-bot
Github Bot to find breaking changes in your schema.graphql
https://github.com/entria/graphql-vigilant-bot
bot breaking-changes github-bot graphql webhook
Last synced: about 1 year ago
JSON representation
Github Bot to find breaking changes in your schema.graphql
- Host: GitHub
- URL: https://github.com/entria/graphql-vigilant-bot
- Owner: entria
- License: mit
- Created: 2017-06-23T15:04:44.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-15T20:02:55.000Z (over 8 years ago)
- Last Synced: 2025-04-12T09:12:18.674Z (about 1 year ago)
- Topics: bot, breaking-changes, github-bot, graphql, webhook
- Language: JavaScript
- Homepage:
- Size: 65.4 KB
- Stars: 55
- Watchers: 16
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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:
[](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](https://ngrok.com/download)
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
>
> 
> Breaking Changes
>
> 