flanksource/Gavel

Run gavel test/lint, upload JSON artifact, and post a sticky PR comment with a summary and artifact link.

Trust Signals

workflow.ymlSHA-pinned

uses: flanksource/gavel@57fcbef5508082e83b6938e6f606c9c1dd06da6b # v0.0.48

tags can be moved; commit SHAs can't. why a SHA?

name	description	required	default
args	Arguments passed to gavel (e.g. "test --lint" or "lint").	no	test --lint
working-directory	Working directory in which gavel is executed.	no	.
version	Gavel release to install. Use a semver tag (e.g. "v1.2.3"), "latest" to resolve the most recent release, or "source" to skip the release download path and rely on a gavel binary the caller has already put on PATH.	no	latest
json-file	Path (relative to working-directory) for the JSON artifact.	no	gavel-results.json
html-file	Path (relative to working-directory) for the HTML artifact.	no	gavel-results.html
artifact-name	Name of the uploaded artifact bundle.	no	gavel-results
comment	Post / update a sticky PR comment with a summary and artifact link.	no	true
comment-header	Unique marker that identifies the sticky comment across runs. Each distinct header keeps its own sticky comment on a PR.	no	gavel
github-token	Token used to post the PR comment. Defaults to the workflow's GITHUB_TOKEN.	no	${{ github.token }}
fail-on-error	Fail the action when gavel exits non-zero. Artifacts and the PR comment are still posted either way.	no	true

name	description
exit-code	Exit code from the gavel invocation.
json-path	Absolute path to the JSON artifact.
html-path	Absolute path to the HTML artifact.
log-path	Absolute path to the captured gavel stderr log (gavel.log). Always present, even when gavel crashes before writing JSON.