From f68ea62b0b67056e23745f3f38a758c82733de8b Mon Sep 17 00:00:00 2001 From: Agus Zubiaga Date: Thu, 27 Oct 2022 17:52:51 -0300 Subject: [PATCH] Add `header` docs and reference v2 --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c73ddf1a..c6f319a6 100644 --- a/README.md +++ b/README.md @@ -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' @@ -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' @@ -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