Skip to content

Commit

Permalink
Add header docs and reference v2
Browse files Browse the repository at this point in the history
  • Loading branch information
agu-z authored Oct 27, 2022
1 parent 94590de commit f68ea62
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,14 @@ 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.

### `header` (optional)

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.

## Example usage

```yaml
uses: agu-z/gql-diff-action@v1
uses: agu-z/gql-diff-action@v2
with:
token: '${{ secrets.GITHUB_TOKEN }}'
old-schema: '~/old-schema.gql'
Expand Down Expand Up @@ -81,7 +85,7 @@ jobs:
kill $SERVER_PID # Stop server
- uses: agu-z/gql-diff-action@v1
- uses: agu-z/gql-diff-action@v2
with:
token: '${{ secrets.GITHUB_TOKEN }}'
old-schema: '~/old-schema.gql'
Expand All @@ -95,6 +99,6 @@ __

This action uses [`graphql-schema-diff`](https://github.com/fabsrc/graphql-schema-diff). Thanks [fabsrc](https://github.com/fabsrc)!

Agus Zubiaga 2020
Agus Zubiaga 2022

MIT licensed

0 comments on commit f68ea62

Please sign in to comment.