actions-marketplace-validations/GraphQL Inspector

Tooling for GraphQL. Compare schemas, find breaking changes, find similar types.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
name	The name of the check ("GraphQL Inspector" by default). In case of multiple GraphQL Inspector Actions, use `name` to prevent GitHub from overwriting results. For example, "Check Public API" and "Check Internal API".	—	—
annotations	Use annotation (enabled by default)	—	—
fail-on-breaking	Fail on breaking changes (enabled by default)	—	—
approve-label	Label to mark Pull Request introducing breaking changes as safe and expected ("approved-breaking-change" by default)	—	—
schema	Ref and Path to GraphQL Schema (e.g. "master:schema.graphql") * Ref is needed where 'endpoint' is not defined * Can be URL to the GraphQL API - should represent the "after" schema. Available only if 'endpoint' is defined. Has to start with http(s).	yes	—
endpoint	An url to the GraphQL API. It should represent the "before" schema. When using an endpoint, 'schema' should point to a file (without a reference - branch name for example)	—	—
github-token	Github Token. Use {{ github.token }} by default	no	${{ github.token }}
experimental_merge	Merge Pull Request's branch with the target branch to get the schema. Helps to get the correct state of schema when Pull Request is behind the target branch (enabled by default)	—	—
rules	Apply rules that change certain checks from Breaking to Dangerous. Rules should be listed as a multiline YAML string, not a list	no	—
onUsage	Used only when the `considerUsage` rule is provided, otherwise this field is ignored. Should be a path to a JS file as described in https://the-guild.dev/graphql/inspector/docs/essentials/diff#considerusage	no	—

Outputs

name	description
changes	Total number of changes