https://github.com/artsy/graphql-slack-updater

A weekly Travis task that sends our GraphQL updates to Slack
https://github.com/artsy/graphql-slack-updater

graphql ruby travis-ci

Last synced: 3 months ago
JSON representation

A weekly Travis task that sends our GraphQL updates to Slack

• Host: GitHub
• URL: https://github.com/artsy/graphql-slack-updater
• Owner: artsy
• License: mit
• Archived: true
• Created: 2017-10-08T23:19:56.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-11-19T03:38:54.000Z (about 6 years ago)
• Last Synced: 2024-07-31T07:18:47.182Z (6 months ago)
• Topics: graphql, ruby, travis-ci
• Language: Ruby
• Homepage: https://travis-ci.org/artsy/graphql-slack-updater/builds
• Size: 11.7 KB
• Stars: 40
• Watchers: 35
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - graphql-slack-updater - A weekly Travis task that sends our GraphQL updates to Slack (Ruby)

README

        
Deprecated in favour of a Peril [scheduled task](https://github.com/artsy/peril-settings/blob/2ef1a80a869f8195dc9f3757d7f5f5a7078d0960/tasks/compareSchemas.ts).

---

# GraphQL slack updater

Provides a weekly slack update for changes to GraphQL servers in Artsy.

### Meta

-   **State:** production

-   **Production:** [travis-ci.org/artsy/graphql-slack-updater](https://travis-ci.org/artsy/graphql-slack-updater/builds)

-   **Point People:** [@orta](https://github.com/orta)

## Why?

There are 5 GraphQL APIs in differing states of production at Artsy. This repo let's us use the type system in GraphQL to keep everyone up to date with the differences in APIs. It's inspired by GitHub's [GraphQL CHANGELOG](https://developer.github.com/v4/changelog/) but this is a weekly Slack message.

_This is currently built _just_ for Artsy infrastructure._ It's probably not too hard to turn into something more generic so that others can use it. Just let us know in the issues that it's worth the extra abstraction.

## How it works?

This repo uses the Travis CI scheduled tasks feature to execute a weekly notification for changes to our GraphQL APIs. 

#### On a CI run:

- It [downloads our last GraphQL APIs from S3](https://github.com/artsy/graphql-slack-updater/blob/master/src/download_old.rb).

- Clones our GraphQL repos (see [servers/](https://github.com/artsy/graphql-slack-updater/tree/master/servers)) and requests a .graphql file for their schema

- It [compares the schemas and sends a slack message](https://github.com/artsy/graphql-slack-updater/blob/master/src/compare.rb) using [graphql-schema_comparator](https://github.com/xuorig/graphql-schema_comparator).

- It [uploads the generated .graphql files to S3](https://github.com/artsy/graphql-slack-updater/blob/master/src/upload_new.rb) so that next week we can compare it with the new one.

### ENV Vars

- `AWS_ACCESS_KEY` - The AWS access key for a user with READ/PUT/LIST access to your S3 bucket

- `AWS_SECRET_KEY` -  The AWS secret for that user

- `SLACK_WEBHOOK_URL` - The internal webhook URL for the CI run