mandiwise/graphql-operation-validation-action

A GitHub Action that validates all operations performed by a client application against a GraphQL schema.

graphql-operation-validation-action's Issues

Error when schema file is not yet used

Assume you have a lot of schema files and specify them using a glob, say schema_location: ${{ github.workspace }}/api/**/*.graphql. If one of the schema files is not used in any operation, then one gets the following error.

 Error: 
      Unable to find any GraphQL type definitions for the following pointers:
        
          - /home/runner/work/..../api/documents/schema.graphql

See https://github.com/JabRef/JabRefOnline/runs/2535901416?check_suite_focus=true for a real-life example.
Specifying the schema in question under excluded_paths doesn't help.

♻️ Breakdown of duties

Hey @mandiwise 👋 Thanks for your work put on this one 👍

This ability to check for all graphQl mutations/queries to a defined schema is really nice and could be really helpful for a lot of project. However the fact that this process is 'captive' of a GitHub Action doesn't provide a lot of flexibilities.

My idea would be to extract all the logic of it in a package that:

• export the main function to be used for example validateGraphqlOperations(dir, schemaFilePath)
• provide a CLI like validate-graphql-operations src schema.graphql

The usage would be really similar to graphql-schema-diff for example.

Finally this action will only import the package and consume it with the @actions/core API.

I can help for the implementation so what do you think of this idea?

Live Blog Global Summit Repo Request

Sorry to open an issue but didn't have a way to contact you can you add or email me the repo for the demo from 4/7/21 thanks :)
[email protected]