A neat summary of the changes you made to your GraphQL schema:
See Example Usage for generated schemas.
Checking in your node_modules directory can cause problems. As an alternative, you can use a tool called @vercel/ncc to compile your code and modules into one file used for distribution.
-
Run npm istall to download all dependencies
npm i -
Install vercel/ncc by running this command in your terminal.
npm i -g @vercel/ncc -
Compile your index.js file.
ncc build index.js --license licenses.txt
A GitHub token used to post a comment to your PR.
${{ secrets.GITHUB_TOKEN }} works here.
The schema before the change. This can be a GraphQL SDL file or an endpoint URL.
The schema after the change. This can be a GraphQL SDL file or an endpoint URL.
A string to use as the header of the PR comment. Use this if you want to generate summaries for multiple schemas in the same PR.
uses: agu-z/gql-diff-action@v2
with:
token: '${{ secrets.GITHUB_TOKEN }}'
old-schema: '~/old-schema.gql'
new-schema: '~/new-schema.gql'The way you generate old and new schema files is up to you.
The following example generates both schemas by running the server before and after the PR change:
name: GraphQL diff
on: pull_request
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- uses: actions/setup-node@v1
with:
node-version: 12.x
- name: Generate new schema
run: |
npm install # Install dependencies
npm start & # Start your server in the background
SERVER_PID=$! # Store server pid in order to stop it afterwards
# Generate the new schema
npx get-graphql-schema http://localhost:5000 ~/new-schema.gql
kill $SERVER_PID # Stop server. This is necessary to free up the port.
- name: Check out PR base ref
run: |
git checkout ${{ github.event.pull_request.base.sha }}
- name: Generate old schema
run: |
npm install # Install dependencies
npm start & # Start your server in the background
SERVER_PID=$! # Store server pid in order to stop it afterwards
# Generate the old schema
npx get-graphql-schema http://localhost:5000 ~/old-schema.gql
kill $SERVER_PID # Stop server
- uses: agu-z/gql-diff-action@v2
with:
token: '${{ secrets.GITHUB_TOKEN }}'
old-schema: '~/old-schema.gql'
new-schema: '~/new-schema.gql'
This is an example for an API written in Node but the same idea works for any language or framework as long as you can start the server in your workflow.
__
This action uses graphql-schema-diff. Thanks fabsrc!
Agus Zubiaga 2022
MIT licensed