iansu/Apollo Schema Check Action
A GitHub Action to run a schema check and post the results as a comment on a Pull Request
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Oct 31, 2022
- License
- MIT
- Runtime
- Deprecated runtime
Pinned Snippet
uses: iansu/apollo-schema-check-action@bd4fa6e111dec97ba26a1cc6895f379014e8a01c # v2.1.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| config | Path to your Apollo config file | no | — |
| graph | The ID of the graph in Apollo Graph Manager to check your proposed schema changes against. Overrides config file if set. | no | — |
| variant | The variant to check the proposed schema against | no | — |
| endpoint | The URL for the CLI to use to introspect your service | no | — |
| headers | Additional headers to send to server for introspectionQuery. Multiple headers can be provided as a comma separated list. NOTE: The `endpoint` input is REQUIRED if using the `headers` input. | no | — |
| key | The API key to use for authentication to Apollo Graph Manager | yes | — |
| localSchemaFile | Path to one or more local GraphQL SDL file(s). Supports comma-separated list of paths (ex. `schema.graphql,extensions.graphql`) | no | — |
| queryCountThreshold | Minimum number of requests within the requested time window for a query to be considered | no | — |
| queryCountThresholdPercentage | Number of requests within the requested time window for a query to be considered, relative to total request count. Expected values are between 0 and 0.05 (minimum 5% of total request volume) | no | — |
| serviceName | Provides the name of the implementing service for a federated graph. This flag will indicate that the schema is a partial schema from a federated service | no | — |
| validationPeriod | The size of the time window with which to validate the schema against. You may provide a number (in seconds), or an ISO8601 format duration for more granularity (see: https://en.wikipedia.org/wiki/ISO_8601#Durations) | yes | — |
| title | The name of the graph which will be shown in the comment | no | — |
| alwaysComment | Leave a comment on the PR even if there are no schema changes in the PR | no | false |
| failOnError | Fail the check if breaking changes or composition errors are found | no | true |
Outputs
no outputs