graphql-binding/graphql-binding-github

Embed GitHub's GraphQL API into your server application

graphql-binding

Deprecation Notice!

In the last few months, since the transition of many libraries under The Guild's leadership, We've reviewed and released many improvements and versions to graphql-cli, graphql-config and graphql-import.

We've reviewed graphql-binding, had many meetings with current users and engaged the community also through the roadmap issue.

What we've found is that the new GraphQL Mesh library is covering not only all the current capabilities of GraphQL Binding, but also the future ideas that were introduced in the original GraphQL Binding blog post and haven't come to life yet.

And the best thing - GraphQL Mesh gives you all those capabilities, even if your source is not a GraphQL service at all!
it can be GraphQL, OpenAPI/Swagger, gRPC, SQL or any other source! And of course you can even merge all those sources into a single SDK.

Just like GraphQL Binding, you get a fully typed SDK (thanks to the protocols SDKs and the GraphQL Code Generator), but from any source, and that SDK can run anywhere, as a connector or as a full blown gateway. And you can share your own "Mesh Modules" (which you would probably call "your own binding") and our community already created many of those! Also, we decided to simply expose regular GraphQL, so you can choose how to consume it using all the awesome fluent client SDKs out there.

If you think that we've missed anything from GraphQL Binding that is not supported in a better way in GraphQL Mesh, please let us know!

Overview

🔗 GraphQL bindings are modular building blocks that allow to embed existing GraphQL APIs into your own GraphQL server. Think about it as turning (parts of) GraphQL APIs into reusable LEGO building blocks. Bindings may be generated in JavaScript, TypeScript, or Flow.

The idea of GraphQL bindings is introduced in detail in this blog post: Reusing & Composing GraphQL APIs with GraphQL Bindings

Install

yarn add graphql-binding

Public GraphQL bindings

You can find practical, production-ready examples here:

• graphql-binding-github
• prisma-binding

Note: If you've created your own GraphQL binding based on this package, please add it to this list via a PR 🙌

If you have any questions, share some ideas or just want to chat about GraphQL bindings, join the #graphql-bindings channel in our Slack.

graphql-binding-github's Issues

Document Github Token workflows for building and using the binding

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

[Docs] example showing integration with `prisma`

Problem

I've spent quite a bit of time trying to get this binding integrated into the prisma node-advanced template with zero success.

I am most definitely using the package wrong, however, I think if we had a realistic example demonstrating proper use, others and myself included would have an easier time using this binding (and bindings in general).

/Users/peter/Sources/Repos/notes/packages/notes-prisma/node_modules/graphql-binding-github/node_modules/graphql/language/parser.js:152
  throw unexpected(lexer);
  ^
GraphQLError: Syntax Error: Unexpected Name "GitObject"
    at syntaxError (/Users/peter/Sources/Repos/notes/packages/notes-prisma/node_modules/graphql-binding-github/node_modules/graphql/error/syntaxError.js:24:10)
    at unexpected (/Users/peter/Sources/Repos/notes/packages/notes-prisma/node_modules/graphql-binding-github/node_modules/graphql/language/parser.js:1322:33)
    at parseDefinition (/Users/peter/Sources/Repos/notes/packages/notes-prisma/node_modules/graphql-binding-github/node_modules/graphql/language/parser.js:152:9)
    at parseDocument (/Users/peter/Sources/Repos/notes/packages/notes-prisma/node_modules/graphql-binding-github/node_modules/graphql/language/parser.js:110:22)
    at parse (/Users/peter/Sources/Repos/notes/packages/notes-prisma/node_modules/graphql-binding-github/node_modules/graphql/language/parser.js:38:10)
    at Object.buildSchema (/Users/peter/Sources/Repos/notes/packages/notes-prisma/node_modules/graphql-binding-github/node_modules/graphql/utilities/buildASTSchema.js:461:43)
    at Object.makeRemoteExecutableSchema (/Users/peter/Sources/Repos/notes/packages/notes-prisma/node_modules/graphql-binding-github/node_modules/graphql-tools/dist/stitching/makeRemoteExecutableSchema.js:54:28)
    at new GitHub (/Users/peter/Sources/Repos/notes/packages/notes-prisma/node_modules/graphql-binding-github/dist/index.js:27:38)
    at Object.<anonymous> (/Users/peter/Sources/Repos/notes/packages/notes-prisma/src/resolvers/Query.js:10:16)
    at Module._compile (module.js:635:30)
[nodemon] app crashed - waiting for file changes before starting...

Thank you

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

Outdated README example

README Example section is outdated, I tried to reproduce the example following the README and I found many problems.

Can I update this section following the example folder?

Convert to static/generated binding

This binding should be converted/made available as a static binding instead of a dynamic binding.

GraphQLError: Syntax Error: Unexpected Name "GitObject"

Syntax Error: Unexpected Name "GitObject"

GraphQL request (336:28)
335: # Represents a Git blob.
336: type Blob implements Node, GitObject {
                                ^
337:   # An abbreviated version of the Git object ID