# update-graphql-schema

**Repository Path**: mirrors_apollographql/update-graphql-schema

## Basic Information

- **Project Name**: update-graphql-schema
- **Description**: A Github Action that downloads your GraphQL schema from introspection and/or the Studio registry and opens a pull request if anything changed.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-06-16
- **Last Updated**: 2025-10-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Update GraphQL Schema 🚀

A Github Action that downloads your GraphQL schema from [introspection](https://graphql.org/learn/introspection/) and/or
the [Apollo GraphOS](https://www.apollographql.com/docs/graphos/) and opens a pull request if anything changed.

This action supports converting an introspection schema to SDL and vice-versa based on the file extension. We recommend
using `.graphqls` to convert to SDL.

### Repository configuration

By default, pull_request created by workflows do not run their checks. This is a security restriction from Github, read
more about
it [In the Github doc](https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow)
. To workaround this, we recommend you create a machine user that has write access to your repo and use a personal
access token (PAT) from this machine user to create the pull_request.

See [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#triggering-further-workflow-runs)
for more possible workarounds.

If you don't need the checks to run, you can use the default GITHUB_TOKEN. For this you'll need to give it permission to
write to your repository and create pull requests:

![](screenshot.png)

### Configuring with introspection

```yaml
name: Update GraphQL schema
# Check every night at midnight
on:
  schedule:
    - cron: "0 0 * * *"

jobs:
  update:
    runs-on: ubuntu-20.04
    steps:
      - uses: actions/checkout@v2
      - uses: apollographql/update-graphql-schema@59d4aa970db7d8559e48a5ddc5b3c09c052c88b0
        with:
          endpoint: "https://example.com/graphql"
          schema: "src/main/graphql/schema.graphqls"

          # Recommended for checks to run on the pull request
          github_token: ${{ secrets.BOT_GITHUB_TOKEN }}

          # Optional HTTP settings for the download
          headers: '{"Authorization": "Bearer $token", "User-Agent": "MyAction"}' # default: ""
          insecure: "false" # default: "false"

          # Optional pull request settings        
          branch: "graphql-schema" # default: "update-schema"
          remote: "origin" # default: "origin"
          token: "abc123" # Default: GITHUB_TOKEN

          # Optional commit settings
          commit_user_name: My GitHub Actions Bot # defaults to "github-actions[bot]"
          commit_user_email: my-github-actions-bot@example.org # defaults to "github-actions[bot]@users.noreply.github.com"
          commit_author: Author <actions@github.com> # defaults to author of the commit that triggered the run
          commit_message: Automated Commit # defaults to "Update GraphQL Schema"
```

### Configuring with [Apollo GraphOS](https://www.apollographql.com/docs/graphos/)

```yaml
name: Update GraphQL schema
on:
  schedule:
    - cron: "0 0 * * *"

jobs:
  update:
    runs-on: ubuntu-20.04
    steps:
      - uses: actions/checkout@v2
      - uses: apollographql/update-graphql-schema@59d4aa970db7d8559e48a5ddc5b3c09c052c88b0
        with:
          key: "service:fullstack-tutorial:abc123"
          schema: "src/main/graphql/schema.graphqls"

          # Recommended for checks to run on the pull request
          github_token: ${{ secrets.BOT_GITHUB_TOKEN }}

          # Optional GraphOS settings
          graph: "fullstack-tutorial" # defaults to being parsed from the key
          graph_variant: "production" # default: "current"

          # Other optional settings are the same as for introspection
```