compaREST/action.yaml
2021-12-13 15:01:44 +03:00

48 lines
1.4 KiB
YAML

name: compaREST
author: Typeable
description: API reliability checker
inputs:
GITHUB_TOKEN:
description: "The GitHub access token (e.g. secrets.GITHUB_TOKEN) used to create or update the comment. This defaults to {{ github.token }}."
default: "${{ github.token }}"
required: false
repo:
description: The owner of the repo in which to post the comment.
default: "${{ github.repository }}"
required: false
project_name:
description: The name of the project to which the API pertains.
required: true
footer:
description: A footer that can be appended to the comment.
required: false
default: ""
old:
description: The path to old specification of the API.
required: true
new:
description: The path to new specification of the API.
required: true
sha:
description: The sha of the commit to post the check for.
required: false
default: "${{ github.event.pull_request.head.sha }}"
runs:
using: "docker"
image: "docker://typeable/comparest-github-action:latest"
env:
GITHUB_TOKEN: "${{ inputs.GITHUB_TOKEN }}"
REPO: "${{ inputs.repo }}"
PROJECT_NAME: "${{ inputs.project_name }}"
FOOTER: "${{ inputs.footer }}"
ROOT: "/github/workspace"
OLD: "${{ inputs.old }}"
NEW: "${{ inputs.new }}"
SHA: "${{ inputs.sha }}"
pre-entrypoint: "/bin/pre"
entrypoint: "/bin/run"
branding:
icon: crosshair
color: gray-dark