git.iko.soy/typeable/compaREST
on 0.1.0.1 help sign in
typeable/compaREST/action.yaml
48 lines 1.5 kB history raw
1name: compaREST
2author: Typeable
3description: API reliability checker
4inputs:
5 GITHUB_TOKEN:
6 description: "The GitHub access token (e.g. secrets.GITHUB_TOKEN) used to create or update the comment. This defaults to {{ github.token }}."
7 default: "${{ github.token }}"
8 required: false
9 repo:
10 description: The owner of the repo in which to post the results.
11 default: "${{ github.repository }}"
12 required: false
13 project_name:
14 description: The name of the project to which the API pertains. Used to name the check. Useful when you have multiple APIs in the same repo.
15 required: false
16 default: ""
17 footer:
18 description: A footer that can be appended to the check body.
19 required: false
20 default: ""
21 old:
22 description: The path to the old (client) specification of the API.
23 required: true
24 new:
25 description: The path to new (server) specification of the API.
26 required: true
27 sha:
28 description: The sha of the commit to post the check for.
29 required: false
30 default: "${{ github.event.pull_request.head.sha }}"
31runs:
32 using: "docker"
33 image: "docker://typeable/comparest-github-action:0.1.0.1"
34 env:
35 GITHUB_TOKEN: "${{ inputs.GITHUB_TOKEN }}"
36 REPO: "${{ inputs.repo }}"
37 PROJECT_NAME: "${{ inputs.project_name }}"
38 FOOTER: "${{ inputs.footer }}"
39 ROOT: "/github/workspace"
40 OLD: "${{ inputs.old }}"
41 NEW: "${{ inputs.new }}"
42 SHA: "${{ inputs.sha }}"
43 pre-entrypoint: "/bin/pre"
44 entrypoint: "/bin/run"
46branding:
47 icon: crosshair
48 color: blue