forked from kamilkisiela/graphql-inspector
-
Notifications
You must be signed in to change notification settings - Fork 0
/
action.yml
45 lines (42 loc) · 1.59 KB
/
action.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
name: 'GraphQL Inspector'
author: 'Kamil Kisiela <[email protected]>'
description: 'Tooling for GraphQL. Compare schemas, find breaking changes, find similar types.'
branding:
icon: 'search'
color: 'orange'
inputs:
name:
description: |
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:
description: 'Use annotation (enabled by default)'
fail-on-breaking:
description: 'Fail on breaking changes (enabled by default)'
approve-label:
description: 'Label to mark Pull Request introducing breaking changes as safe and expected ("approved-breaking-change" by default)'
schema:
description: |
Ref and Path to GraphQL Schema (e.g. "master:schema.graphql")
* Ref is needed where 'endpoint' is not defined
required: true
endpoint:
description: |
Url to your GraphQL API
When using an endpoint, 'schema' should point to a file (without a reference - branch name for example)
github-token:
default: '${{ github.token }}'
required: false
description: 'Github Token. Use {{ github.token }} by default'
experimental_merge:
description: |
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
(disabled by default)
outputs:
changes:
description: 'Total number of changes'
runs:
using: 'node12'
main: 'action/index.js'