apollographql/Update GraphQL schema
Downloads a new version of your GraphQL schema and opens a pull request if it changed
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Apr 20, 2024
- License
- MIT
- Runtime
- Deprecated runtime
Pinned Snippet
uses: apollographql/update-graphql-schema@268c76047cb4693d9814d0fbf746f1f84e4ac0b5 # no releases — HEAD as of 2026-07-13tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| schema | The path to the schema file to be updated | yes | — |
| token | The github token to use to create the pull request. Using a machine account personal access token is recommended. if you want the pull request checks to run. | yes | ${{ github.token }} |
| graph | [Apollo Studio users only] The identifier of the Apollo graph used to download the schema. | no | — |
| key | [Apollo Studio users only] The Apollo API key. See https://www.apollographql.com/docs/studio/api-keys/ for more information on how to get your API key. | no | — |
| graph_variant | [Apollo Studio users only] The variant of the Apollo graph used to download the schema. | no | current |
| registryUrl | [Apollo Studio users only] The registry url of the registry instance used to download the schema. | no | https://graphql.api.apollographql.com/api/graphql |
| endpoint | The url of the GraphQL endpoint for introspection | no | — |
| headers | A JSON object representing the HTTP headers to use while introspecting `endpoint` | no | — |
| insecure | Do not verify certificates during download | no | false |
| base_branch | The branch into which you want the schema merged. If not set, will use the default branch | no | — |
| branch | The name of the branch to use to create the pull request | no | update-graphql-schema |
| remote | The remote to push the branch used to create the pull request | no | origin |
| pr_title | The title of the pull request that is created | no | Update GraphQL Schema |
| pr_body | The body of the pull request that is created | no | Update GraphQL Schema |
| commit_user_name | Name used for the commit user | no | github-actions[bot] |
| commit_user_email | Email address used for the commit user | no | github-actions[bot]@users.noreply.github.com |
| commit_author | Value used for the commit author. Defaults to the username of whoever triggered this workflow run. | no | ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com> |
| commit_message | Value used for the commit message. | no | Update GraphQL Schema |
Outputs
no outputs