v4lproik/github-actionspec

Capture or validate normalized GitHub Actions workflow payloads against repository-owned CUE declarations.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
mode	Action mode. Supported values are `emit-fragment`, `capture`, and `validate-repo`.	no	validate-repo
emit-job	Job id to write into the fragment in emit-fragment mode.	no	""
emit-result	Job result to write into the fragment in emit-fragment mode.	no	""
emit-outputs	Optional newline-separated list of KEY=VALUE job outputs for emit-fragment mode.	no	""
emit-matrix	Optional newline-separated list of KEY=VALUE matrix entries for emit-fragment mode.	no	""
emit-step-conclusions	Optional newline-separated list of STEP_ID=CONCLUSION values for emit-fragment mode.	no	""
emit-step-outputs	Optional newline-separated list of STEP_ID.OUTPUT_NAME=VALUE values for emit-fragment mode.	no	""
emit-file	Path where the action should write the job fragment JSON in emit-fragment mode. When omitted, the action writes under the runner temp directory.	no	""
repo	Path to the target repository containing .github/actionspec declarations.	no	.
workflow	Workflow file name to capture or validate. Optional for validate-repo when the provided payloads all belong to the same workflow.	no	""
ref-name	Optional workflow ref recorded in capture mode.	no	""
capture-job-files	Path to one job fragment JSON file, a directory of fragment JSON files, a glob pattern, or a newline-separated list of those inputs for capture mode.	no	.github/actionspec-fragments
capture-inputs	Optional newline-separated list of KEY=VALUE workflow inputs recorded in capture mode.	no	""
capture-file	Path where the action should write the normalized workflow payload in capture mode. When omitted, the action writes under the runner temp directory.	no	""
actual	Path to a normalized workflow run JSON payload, a directory of JSON payloads, a glob pattern, or a newline-separated list of payload paths or glob patterns.	no	.github/actionspec-artifacts
declarations-dir	Path to the declarations directory inside the target repository.	no	.github/actionspec
report-file	Path where the action should write the JSON validation report. When omitted, the action writes under the runner temp directory.	no	""
baseline-report	Optional path to a previous JSON validation report used to render dashboard diffs.	no	""
dashboard-file	Path where the action should write the markdown matrix dashboard. When omitted, the action writes `dashboard.md` next to `report-file`.	no	""
dashboard-output-keys	Optional newline-separated list of job output keys to render in the dashboard and PR comment.	no	""
write-summary	Whether to append the rendered dashboard to the GitHub Actions job summary.	no	true
comment-pr	Whether to upsert the rendered dashboard as a PR comment when the workflow runs on a pull request.	no	false
comment-title	Title used for the PR comment when comment-pr is enabled.	no	Workflow Matrix Dashboard
comment-tag	Stable tag used to find and update the existing PR matrix comment.	no	github-actionspec-matrix
github-token	GitHub token used for PR comment upserts when comment-pr is enabled.	no	""

Outputs

name	description
fragment-path	Path to the job fragment JSON written by the action in emit-fragment mode.
capture-path	Path to the normalized workflow payload written by the action in capture mode.
report-path	Path to the JSON validation report written by the action.
dashboard-path	Path to the markdown dashboard written by the action.