✨ Features

• Simple configuration
  • yaml, json, jsonc support
  • overloading with environment variables
• Schema comparison from url, graphql files or git
• Configurable Slack notifications
  • webhook url
  • possibility to define mentions

🚀 Quick setup

1. Create gqlcompare.json configuration file in root folder of project
2. Use gqlcompare command to compare your schemas

⚙️ Configuration

• To use different config file name or .yaml, or .jsonc extensions, specify path to the file with --config option
• Each configuration needs to start with key that defines name of the configuration (schema)
• Every key can be replaced with &&<ENV_VARIABLE_NAME> string to load the value from env
• All ENV variables will overwrite all configurations, all needs to be prefixed with GQL_COMPARE_, e.g. GQL_COMPARE_OLD_SCHEMA='./schema.gql

Options

Key	Type	ENV	Description
schemas.old.ref	string (url, git ref or file path)	OLD_SCHEMA	Pointer to old schema
schemas.old.auth	string	OLD_SCHEMA_AUTH	Authorization header for url loader
schemas.new.ref	string (url, git ref or file path)	NEW_SCHEMA	Pointer to new
settings.environment	string	NEW_SCHEMA_AUTH	Environment (mentioned in notificaitons)
settings.failLevel	"breaking", "dangerous", "any" or "never"	FAIL_LEVEL	Which changes in schema will cause that script fails
notifications.slack.url	string	SLACK_URL	Webhook url to publish messages
notifications.slack.mentions	string (values separated with ,)	SLACK_MENTIONS	id of users or groups to mention in the slack message (for groups use group: prefix)

Example config

graphql.yml

1client:
2  schemas:
3    old:
4      ref: https://test-client-schema/graphql
5    new:
6      ref: ./graphql/schema.client.graphql
7  settings:
8      failLevel: breaking
9  notifications:
10    slack:
11      mentions: 'group:STAMZNREY,group:S015S9JNJ1M' # Android, iOS
12admin:
13  schemas:
14    old:
15      ref: https://test-admin-schema/graphql
16      auth: 'AUTHORIZATION_TOKEN'
17    new:
18      ref: ./graphql/schema.admin.graphql
19  settings:
20      failLevel: never
21      environment: $$NODE_ENV # Loaded by NODE_ENV env variable
22  notifications:
23    slack:
24      url: https://test-slack-webhook/
25      mentions: 'group:S01TESTID,U123' # Group S01TESTID, user U123
26