typeable/compaREST

API reliability checker

Trust Signals

name	description	required	default
GITHUB_TOKEN	The GitHub access token (e.g. secrets.GITHUB_TOKEN) used to create or update the comment. This defaults to {{ github.token }}.	no	${{ github.token }}
repo	The owner of the repo in which to post the results.	no	${{ github.repository }}
project_name	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.	no	""
footer	A footer that can be appended to the check body.	no	""
old	The path to the old (client) specification of the API.	yes	—
new	The path to new (server) specification of the API.	yes	—
sha	The sha of the commit to post the check for.	no	${{ github.event.pull_request.head.sha }}

no outputs